AnvilHDL Documentation

The documentation sources are organized into:

• docs/tutorial/: installation and tutorial chapters.
• docs/langref/: language reference topics, with grouped expression pages in expressions/.
• docs/index.rst: the documentation home page and navigation.
• docs/artefacts.md: project repositories, research artefacts, and contributors.

Create a local Python environment and install the documentation dependencies once:

python3 -m venv --without-pip .venv
python3 -m pip --python .venv/bin/python install -r docs/requirements.txt

Then build the documentation. The build script uses .venv automatically:

bash build-docs.sh

The documentation will be generated in the docs/_build/html directory.

To test the documentation locally, run the following command. It builds the documentation and then starts a local server:

bash run-server.sh

Note: After each change to the documentation, rebuild it using build-docs.sh or run-server.sh.