Building the documentation
==========================

In order to build the documentation in the ``docs`` directory, you will need to have the `Sphinx <https://www.sphinx-doc.org/en/master/>`_ Python package.
Yyou will need several Sphinx extensions that can be installed directly with pip:

.. code-block::

    pip install -r docs/requirements.txt

Build as a webpage
------------------

To build the documentation as a html webpage (what appears at https://h-transport-materials.readthedocs.io):

.. code::

    cd docs
    make.bat html

Test the documentation
----------------------

The code blocks and examples given in the documentation can be tested by running:

.. code::

    cd docs
    make.bat doctest

The documentation is also automatically tested as part of the CI.