Run formatter

docs/index.rst

@@ -2,57 +2,51 @@
 
 .. _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/*
 
-*****************
- Anemoi packages
-*****************
+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>`
+- :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
-*********
+License
+-------
 
 *Anemoi* is available under the open source `Apache License`__.
 

docs/installing.rst

@@ -1,34 +1,32 @@
-############
- Installing
-############
+Installing
+==========
 
 To install the package, you can use the following command:
 
-.. code:: bash
+.. code-block:: bash
 
-   pip install anemoi-utils[...options...]
+    pip install anemoi-utils[...options...]
 
 The options are:
 
--  ``dev``: install the development dependencies
--  ``all``: install all the dependencies
--  ``text``: install the dependencies for text processing
--  ``provenance``: install the dependencies for provenance tracking
--  ``grib``: install the dependencies for looking up GRIB parameters
+- ``dev``: install the development dependencies
+- ``all``: install all the dependencies
+- ``text``: install the dependencies for text processing
+- ``provenance``: install the dependencies for provenance tracking
+- ``grib``: install the dependencies for looking up GRIB parameters
 
-**************
- Contributing
-**************
+Contributing
+------------
 
-.. code:: bash
+.. code-block:: bash
 
-   git clone ...
-   cd anemoi-utils
-   pip install .[dev]
-   pip install -r docs/requirements.txt
+    git clone ...
+    cd anemoi-utils
+    pip install .[dev]
+    pip install -r docs/requirements.txt
 
 You may also have to install pandoc on MacOS:
 
-.. code:: bash
+.. code-block:: bash
 
-   brew install pandoc
+    brew install pandoc

docs/modules/checkpoints.rst

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

docs/modules/config.rst

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

docs/modules/dates.rst

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

docs/modules/grib.rst

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

docs/modules/humanize.rst

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

docs/modules/provenance.rst

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

docs/modules/text.rst

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