Sphinx

The Sphinx starter is a Python-only uv project. It uses MyST Markdown and a local NVIDIA Elements theme that extends Sphinx's bundled basic theme.

Create a Project

Use the Elements CLI to download the starter:

nve project.create --type=sphinx
cd sphinx
uv sync --locked

The CLI scaffolds the project and prints the uv commands without installing dependencies or starting a server.

Develop Locally

uv run sphinx-autobuild docs dist

Build for Production

uv run --locked sphinx-build -W --keep-going -n -b html docs dist

Theme and CDN Assets

The theme source lives in docs/_themes/nvidia_elements. It provides Sphinx search, document and page navigation, breadcrumbs, previous and next links, responsive mobile behavior, and a persisted light or dark color scheme.

Released starter archives pin the Elements themes, fonts, styles, and core bundle to exact package versions. Source templates keep the URLs free of versions so repository builds always stamp the current package versions.