Documentation

CI

Workflow in repo to build the documentation: .github\workflows\documentation-build.yml

The documentation is made available to the public using GitHub pages: https://pages.github.com/

The documentation is available at: https://docs.easyreflectometry.org/

Local

Sphinx is used to build documentation.

• Sphinx entry point index.rst
• Sphinx configuration docs\conf.py
• Sphinx documentation https://www.sphinx-doc.org/

To get the required environment:

pip install -e .[dev,docs]

Then enter the docs folder and execute:

.\make.bat html

To inspect the produced homepage in an browser open:

docs\_build\html\index.html

In case of unexpected behavior it might be beneficial to wipe the build directory:

docs\_build