Documentation¶

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

Install¶

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

1
2
3
4
5
6
7

sphinx>=4
git+https://github.com/jbms/sphinx-immaterial@98d0ab6b618fb9a9fe6a0f33ac6875bbbbb05ad2
myst-parser
sphinx-design
sphinxcontrib-details-directive
ipykernel
numpy

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 html -v docs/ docs/build/

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