Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
shouptech committed Jan 2, 2019
1 parent 10c7627 commit c6ce041
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
# 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']
Expand Down Expand Up @@ -94,7 +94,7 @@
# 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.
Expand Down
15 changes: 12 additions & 3 deletions docs/installing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`
4 changes: 4 additions & 0 deletions docs/usage.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
Using Synthale
==============

.. click:: synthale.cli:cli
:prog: synthale
:show-nested:

0 comments on commit c6ce041

Please sign in to comment.