Documentation example

We use this example in the lesson How to document your research software.

Host the project for local development

Generating the documentation pages is based on sphinx and the sphinx_rtd_theme.

Docker

For convenience, a docker-based setup is provided here. To get started, simply run:

docker compose up

after which the documentation pages will be hosted with hot reload on 127.0.0.1:8000

Python

The following PyPI packages are required:

• Sphinx
• sphinx_rtd_theme
• myst_parser

When these are installed in your environment, you can run:

sphinx-build doc _build
python -m http.server 8000 --directory _build

after which the documentation pages will be hosted on 127.0.0.1:8000