From a8ee94b9c9169f051b88a1e13f299e0caadc5ad9 Mon Sep 17 00:00:00 2001 From: Florian Maurer Date: Wed, 7 Aug 2024 11:31:11 +0200 Subject: [PATCH] readd cli docs relative to .rst file change docs as well until https://github.com/sphinx-doc/sphinx-argparse/issues/61 is resolved --- README.md | 2 +- docs/source/command_line_interface.rst | 5 +++++ docs/source/index.rst | 2 ++ 3 files changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 64b92905..d0ba9d72 100644 --- 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 index 8cc1b4dd..932407bd 100644 --- 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 index cac372f8..f08353f0 100644 --- 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