diff --git a/docs/cli/checkpoint.rst b/docs/cli/checkpoint.rst new file mode 100644 index 0000000..490839a --- /dev/null +++ b/docs/cli/checkpoint.rst @@ -0,0 +1,8 @@ +copy +==== + +.. argparse:: + :module: anemoi.datasets.__main__ + :func: create_parser + :prog: anemoi-datasets + :path: copy diff --git a/docs/cli/introduction.rst b/docs/cli/introduction.rst new file mode 100644 index 0000000..21ac028 --- /dev/null +++ b/docs/cli/introduction.rst @@ -0,0 +1,25 @@ +Introduction +============ + +When you install the `anemoi-inference` package, this will also install command line tool +called ``anamois-inference`` this can be used to manage the checkpoints. + +The tools can provide help with the ``--help`` options: + +.. code-block:: bash + + % anamoi-inference --help + +The commands are: + +.. toctree:: + :maxdepth: 1 + + checkpoint + metadata + +.. argparse:: + :module: anemoi.inference.__main__ + :func: create_parser + :prog: anemoi-inference + :nosubcommands: diff --git a/docs/cli/metadata.rst b/docs/cli/metadata.rst new file mode 100644 index 0000000..b4a6687 --- /dev/null +++ b/docs/cli/metadata.rst @@ -0,0 +1,10 @@ +create +====== + +Use this command to create a dataset from a recipe file: + +.. argparse:: + :module: anemoi.datasets.__main__ + :func: create_parser + :prog: anemoi-datasets + :path: create diff --git a/docs/conf.py b/docs/conf.py index 208e3d0..d9d5ce7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -61,6 +61,7 @@ "sphinx.ext.intersphinx", "sphinx.ext.autodoc", "sphinx.ext.napoleon", + "sphinxarg.ext", ] # Add any paths that contain templates here, relative to this directory. diff --git a/docs/index.rst b/docs/index.rst index 20e7050..e27b713 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -27,6 +27,30 @@ packages. installing +Modules +------- + +.. toctree:: + :maxdepth: 1 + :glob: + + modules/* + +**Command line tool** + +- :doc:`cli/introduction` +- :doc:`cli/checkpoint` +- :doc:`cli/metadata` + +.. toctree:: + :maxdepth: 1 + :hidden: + :caption: Command line tool + + cli/introduction + cli/checkpoint + cli/metadata + Anemoi packages --------------- diff --git a/docs/modules/runner.rst b/docs/modules/runner.rst new file mode 100644 index 0000000..1fbdb73 --- /dev/null +++ b/docs/modules/runner.rst @@ -0,0 +1,7 @@ +runner +====== + +.. automodule:: anemoi.inference.runner + :members: + :no-undoc-members: + :show-inheritance: diff --git a/docs/requirements.txt b/docs/requirements.txt index c85e9f1..8b8bccd 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,6 +2,7 @@ sphinx sphinx_rtd_theme nbsphinx +sphinx_argparse # Also requires `brew install pandoc` on Mac pandoc