From c6ce04189e954cc42dd548bd37cf7bd795d0502e Mon Sep 17 00:00:00 2001 From: Mike Shoup Date: Wed, 2 Jan 2019 12:38:22 -0700 Subject: [PATCH] Update docs --- docs/conf.py | 4 ++-- docs/installing.rst | 15 ++++++++++++--- docs/usage.rst | 4 ++++ 3 files changed, 18 insertions(+), 5 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index d6c09db..7ca1437 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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. diff --git a/docs/installing.rst b/docs/installing.rst index 155ff24..38e9cf9 100644 --- a/docs/installing.rst +++ b/docs/installing.rst @@ -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` diff --git a/docs/usage.rst b/docs/usage.rst index 9117611..b148241 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -1,2 +1,6 @@ Using Synthale ============== + +.. click:: synthale.cli:cli + :prog: synthale + :show-nested: