mirror of
https://github.com/shouptech/synthale.git
synced 2026-02-03 15:39:45 +00:00
Update docs
This commit is contained in:
parent
10c7627b65
commit
c6ce04189e
3 changed files with 18 additions and 5 deletions
|
|
@ -31,7 +31,7 @@ sys.path.insert(0, os.path.abspath('../src'))
|
|||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = ['sphinx.ext.autodoc']
|
||||
extensions = ['sphinx.ext.autodoc', 'sphinx_click.ext']
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
|
@ -94,7 +94,7 @@ html_theme = 'alabaster'
|
|||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
# html_static_path = ['_static']
|
||||
|
||||
# Custom sidebar templates, must be a dictionary that maps document names
|
||||
# to template names.
|
||||
|
|
|
|||
|
|
@ -35,9 +35,18 @@ As long as `pip` succesfully installs Synthale, you can simply type the
|
|||
::
|
||||
|
||||
$ synthale
|
||||
Usage: synthale [OPTIONS] INPUT_PATH OUTPUT_PATH
|
||||
Try "synthale --help" for help.
|
||||
Usage: synthale [OPTIONS] COMMAND [ARGS]...
|
||||
|
||||
Synthale converts BeerXML files to markdown.
|
||||
|
||||
Copyright (C) 2019 Mike Shoup
|
||||
|
||||
Options:
|
||||
--help Show this message and exit.
|
||||
|
||||
Commands:
|
||||
generate Generate markdown files from BeerXML files.
|
||||
version Print version and exit.
|
||||
|
||||
Error: Missing argument "INPUT_PATH".
|
||||
|
||||
Now, move onto :doc:`usage`
|
||||
|
|
|
|||
|
|
@ -1,2 +1,6 @@
|
|||
Using Synthale
|
||||
==============
|
||||
|
||||
.. click:: synthale.cli:cli
|
||||
:prog: synthale
|
||||
:show-nested:
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue