Documentation¶

The galois documentation is generated with Sphinx and the Sphinx Immaterial theme.

Install¶

The documentation dependencies are stored in docs/requirements.txt.

sphinx < 5.4
git+https://github.com/jbms/sphinx-immaterial@1293f243d4e2214fa25837d698e6a69b7ff8d605
myst-parser
sphinx-design
sphinxcontrib-details-directive
ipykernel

Install the documentation dependencies by passing the -r switch to pip install.

$ python3 -m pip install -r docs/requirements.txt

Build the docs¶

The documentation is built by running the sphinx-build command.

$ sphinx-build -b dirhtml -v docs/ docs/build/

The HTML output is located in docs/build/. The home page is docs/build/index.html.

Serve the docs¶

Since the site is built to use directories (*/getting-started/ not */getting-started.html), it is necessary to serve the webpages locally with a webserver. This is easily done using the built-in Python http module.

$ python3 -m http.server 8080 -d docs/build/

The documentation is accessible from a web browser at http://localhost:8080/.