Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
b8raoult committed May 28, 2024
1 parent c3ab66c commit a62f8f1
Show file tree
Hide file tree
Showing 7 changed files with 76 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/cli/checkpoint.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
copy
====

.. argparse::
:module: anemoi.datasets.__main__
:func: create_parser
:prog: anemoi-datasets
:path: copy
25 changes: 25 additions & 0 deletions docs/cli/introduction.rst
Original file line number Diff line number Diff line change
@@ -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:
10 changes: 10 additions & 0 deletions docs/cli/metadata.rst
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
24 changes: 24 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------

Expand Down
7 changes: 7 additions & 0 deletions docs/modules/runner.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
runner
======

.. automodule:: anemoi.inference.runner
:members:
:no-undoc-members:
:show-inheritance:
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sphinx
sphinx_rtd_theme
nbsphinx
sphinx_argparse

# Also requires `brew install pandoc` on Mac
pandoc
Expand Down

0 comments on commit a62f8f1

Please sign in to comment.