Building Documentation

Prerequisites

If you don't already have a uv environment setup, refer to the Get Started guide.

Install Documentation Dependencies

uv sync --only-dev

Build Documentation

make -C docs

# preview with local server (open http://localhost:8000 in your browser)
python -m http.server --directory docs/build/html 8000

Outputs to docs/build/docs/html

Optional Quick Build Command

A full documentation build can take several minutes. The time consuming steps are building the Python API and performing the link check.

To skip both of these steps, you can use the following command:

NAT_DISABLE_API_BUILD=1 make -C docs html

To run the link check separately, use:

make -C docs linkcheck

Note: When viewing documentation locally, the version switcher in the navigation bar will redirect to the production documentation site (https://docs.nvidia.com/nemo/agent-toolkit/) when selecting a different version. This is expected behavior, as the version switcher uses absolute URLs to ensure proper page path preservation in production.

Contributing

Refer to the Contributing to NeMo Agent Toolkit guide.

When you create your pull request, CI will perform a documentation build as part of the pipeline. If successful, the documentation will be available for download as an artifact.