Cocotb documentation
This directory contains the documentation of cocotb, which is built with Doxygen and Sphinx.
The documentation is automatically built and uploaded with every pull request.
The documentation for the master branch can be found here.
nox -e docs can be used to create an appropriate virtual environment and
invoke sphinx-build to generate the HTML docs.
In addition to the Python dependencies managed by nox, doxygen must be
installed.
Other nox environments (run with nox -e <env>):
docs_linkcheck- run the Sphinxlinkcheckbuilderdocs_spelling- run a spellchecker on the documentation