update

.pre-commit-config.yaml

@@ -62,6 +62,7 @@ repos:
   rev: v0.0.14
   hooks:
     - id: rstfmt
+      exclude: 'cli/.*' # Because we use argparse
 
 - repo: https://github.com/b8raoult/pre-commit-docconvert
   rev: "0.1.4"

docs/index.rst

@@ -2,66 +2,72 @@
 
 .. _index-page:
 
-Welcome to Anemoi's documentation!
-==================================
+####################################
+ Welcome to Anemoi's documentation!
+####################################
 
 .. warning::
 
-    This documentation is work in progress.
+   This documentation is work in progress.
 
-*Anemoi* is a framework for developing machine learning weather forecasting models. It
-comprises of components or packages for preparing training datasets, conducting ML model
-training and a registry for datasets and trained models. *Anemoi* provides tools for
-operational inference, including interfacing to verification software. As a framework it
-seeks to handle many of the complexities that meteorological organisations will share,
-allowing them to easily train models from existing recipes but with their own data.
+*Anemoi* is a framework for developing machine learning weather
+forecasting models. It comprises of components or packages for preparing
+training datasets, conducting ML model training and a registry for
+datasets and trained models. *Anemoi* provides tools for operational
+inference, including interfacing to verification software. As a
+framework it seeks to handle many of the complexities that
+meteorological organisations will share, allowing them to easily train
+models from existing recipes but with their own data.
 
-This package provides a series of utility functions for used by the rest of the *Anemoi*
-packages.
+This package provides a series of utility functions for used by the rest
+of the *Anemoi* packages.
 
-- :doc:`installing`
+-  :doc:`installing`
 
 .. toctree::
-    :maxdepth: 1
-    :hidden:
+   :maxdepth: 1
+   :hidden:
 
-    installing
+   installing
 
-Modules
--------
+*********
+ Modules
+*********
 
 .. toctree::
-    :maxdepth: 1
-    :glob:
+   :maxdepth: 1
+   :glob:
 
-    modules/*
+   modules/*
 
 **Command line tool**
 
-- :doc:`cli/introduction`
-- :doc:`cli/checkpoint`
-- :doc:`cli/metadata`
+-  :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
----------------
-
-- :ref:`anemoi-utils <anemoi-utils:index-page>`
-- :ref:`anemoi-datasets <anemoi-datasets:index-page>`
-- :ref:`anemoi-models <anemoi-models:index-page>`
-- :ref:`anemoi-training <anemoi-training:index-page>`
-- :ref:`anemoi-inference <anemoi-inference:index-page>`
-
-License
--------
+   :maxdepth: 1
+   :hidden:
+   :caption: Command line tool
+
+   cli/introduction
+   cli/checkpoint
+   cli/metadata
+
+*****************
+ Anemoi packages
+*****************
+
+-  :ref:`anemoi-utils <anemoi-utils:index-page>`
+-  :ref:`anemoi-datasets <anemoi-datasets:index-page>`
+-  :ref:`anemoi-models <anemoi-models:index-page>`
+-  :ref:`anemoi-training <anemoi-training:index-page>`
+-  :ref:`anemoi-inference <anemoi-inference:index-page>`
+
+*********
+ License
+*********
 
 *Anemoi* is available under the open source `Apache License`__.
 

docs/installing.rst

@@ -1,24 +1,26 @@
-Installing
-==========
+############
+ Installing
+############
 
 To install the package, you can use the following command:
 
-.. code-block:: bash
+.. code:: bash
 
-    pip install anemoi-inference
+   pip install anemoi-inference
 
-Contributing
-------------
+**************
+ Contributing
+**************
 
-.. code-block:: bash
+.. code:: bash
 
-    git clone ...
-    cd anemoi-inference
-    pip install .[dev]
-    pip install -r docs/requirements.txt
+   git clone ...
+   cd anemoi-inference
+   pip install .[dev]
+   pip install -r docs/requirements.txt
 
 You may also have to install pandoc on MacOS:
 
-.. code-block:: bash
+.. code:: bash
 
-    brew install pandoc
+   brew install pandoc

docs/modules/runner.rst

@@ -1,7 +1,8 @@
-runner
-======
+########
+ runner
+########
 
 .. automodule:: anemoi.inference.runner
-    :members:
-    :no-undoc-members:
-    :show-inheritance:
+   :members:
+   :no-undoc-members:
+   :show-inheritance: