Generating the documentation

Nxpy’s documentation is written in reStructuredText and rendered with Sphinx. It is published on ReadTheDocs, configured by .readthedocs.yaml in the root directory; the requirements for building it are listed in docs/requirements.txt.

To build the HTML documentation locally with uv, run the following in the root directory:

uv run --no-project --with-requirements docs/requirements.txt sphinx-build -b html docs docs/_build/html