DEVELOP.rst

Developer Guide

The project is written using Sphinx and ReStructuredText.

Working on the project

You will need a recent installation of Python 3.

Change into the docs directory:

$ cd docs

For help, run:

$ make

Crate Docs Build

Run `make <TARGET>`, where <TARGET> is one of:

  dev     Run a Sphinx development server that builds and lints the
          documentation as you edit the source files

  html    Build the static HTML output

  check   Build, test, and lint the documentation

  reset   Reset the build cache

You must install fswatch to use the dev target.

Continuous integration and deployment

This project uses GitHub Actions to run make check from the docs directory.

Also, Read the Docs automatically rebuilds the documentation whenever an active docs branch is updated.

To make changes to the RTD configuration (e.g., to activate or deactivate a release version), please contact an admin.