emma/synthale
1
0
Fork 0
mirror of https://github.com/shouptech/synthale.git synced 2026-02-03 15:39:45 +00:00
Code Issues Releases Wiki Activity

Update docs

Browse source
This commit is contained in:
Emma 2019-01-02 12:38:22 -07:00
parent 10c7627b65
commit c6ce04189e
3 changed files with 18 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/conf.py
View file

@ -31,7 +31,7 @@ sys.path.insert(0, os.path.abspath('../src'))
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = ['sphinx.ext.autodoc'] extensions = ['sphinx.ext.autodoc', 'sphinx_click.ext']
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
@ -94,7 +94,7 @@ html_theme = 'alabaster'
# Add any paths that contain custom static files (such as style sheets) here, # 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, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # 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 # Custom sidebar templates, must be a dictionary that maps document names
# to template names. # to template names.

15
docs/installing.rst
View file

@ -35,9 +35,18 @@ As long as `pip` succesfully installs Synthale, you can simply type the
:: ::
$ synthale $ synthale
Usage: synthale [OPTIONS] INPUT_PATH OUTPUT_PATH Usage: synthale [OPTIONS] COMMAND [ARGS]...
Try "synthale --help" for help.
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` Now, move onto :doc:`usage`

4
docs/usage.rst
View file

@ -1,2 +1,6 @@
Using Synthale Using Synthale
============== ==============
.. click:: synthale.cli:cli
:prog: synthale
:show-nested: