File size: 693 Bytes
cb65407 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | 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](https://docs.cocotb.org/en/latest/).
`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 Sphinx `linkcheck` builder
* `docs_spelling` - run a spellchecker on the documentation
|