readd cli docs relative to .rst file

change docs as well until sphinx-doc/sphinx-argparse#61 is resolved
assume-framework · Aug 7, 2024 · a8ee94b · a8ee94b
1 parent ccfe528
commit a8ee94b
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -185,7 +185,7 @@ sphinx-apidoc -o docs/source -Fa assume
 To create and serve the documentation locally, use:
 
 ```bash
-make -C docs html && python -m http.server --directory docs/build/html
+cd docs/source && python -m sphinx . ../build && cd ../.. && python -m http.server --directory docs/build/html
 ```
 
 ## Contributors and Funding

diff --git a/docs/source/command_line_interface.rst b/docs/source/command_line_interface.rst
@@ -15,3 +15,8 @@ There is a command line interface available to assume which makes it easy to run
 It takes an input folder relative from the place it was run from.
 
 The following command line parameters are available in the CLI:
+
+.. argparse::
+   :filename: ../../assume_cli/cli.py
+   :func: create_parser
+   :prog: assume
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -81,6 +81,7 @@ Documentation
 * :doc:`buffers`
 * :doc:`support_policies`
 * :doc:`distributed_simulation`
+* :doc:`command_line_interface`
 * :doc:`assume`
 
 .. toctree::
@@ -97,6 +98,7 @@ Documentation
    buffers
    support_policies
    distributed_simulation
+   command_line_interface
    assume