nvidia-sphinx-theme

What it is and what it does

nvidia-sphinx-theme is a Sphinx documentation theme that builds on top of PyData Sphinx Theme and adds NVIDIA-specific branding, fonts, and styling. It is installed as a Python package and activated by setting html_theme = "nvidia_sphinx_theme" in a Sphinx conf.py file. The theme inherits most configuration from PyData Sphinx Theme, so users familiar with that theme will recognize the setup process.

The package is designed for NVIDIA projects and documentation. It depends only on sphinx and pydata-sphinx-theme, making installation straightforward. However, its proprietary license agreement restricts use to NVIDIA products and services; it cannot be freely used in unrelated projects or redistributed. The project is in an aging maintenance state, so active development or rapid bug fixes should not be expected.

Use it for:

• Styling Sphinx documentation for NVIDIA software projects with consistent branding and visual identity.
• Building internal documentation sites for teams working on NVIDIA products or services.
• Extending PyData Sphinx Theme with NVIDIA fonts, icons, and design elements for official documentation.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A Sphinx theme that extends PyData Sphinx Theme with NVIDIA branding and styling for documentation projects.

Yes, but only if you are building documentation for an NVIDIA product or service and the license terms permit your use case. The theme is straightforward to install and configure. However, the proprietary license is restrictive—verify that your project qualifies as a 'NVIDIA product or service' before committing. The aging maintenance status means you should not expect frequent updates or rapid fixes.

Install

nvidia-sphinx-theme on PyPI

pip install nvidia-sphinx-theme

uv add nvidia-sphinx-theme

poetry add nvidia-sphinx-theme

Installing nvidia-sphinx-theme

Before you install

Low install friction with only two runtime dependencies (sphinx and pydata-sphinx-theme). Maintenance status is aging—last release was 278 days ago—so updates and bug fixes may be infrequent.

License in practice

Licensed under NVIDIA's proprietary license agreement, not open source. The license restricts use to NVIDIA products and services, prohibits reverse engineering, derivative works, and redistribution. Review the full terms carefully before adopting in commercial or public projects.

Quickstart

pip install nvidia-sphinx-theme

In conf.py:
html_theme = "nvidia_sphinx_theme"

Requires Python 3.10 or later. The proprietary license restricts use to NVIDIA products and services only.

Verify before relying

• Whether the license restriction to 'NVIDIA products and services' permits use in third-party projects that integrate NVIDIA tools or merely reference NVIDIA.
• Current maintenance status and whether the project is actively developed or in maintenance-only mode.
• Specific visual or functional differences from PyData Sphinx Theme beyond branding.

Package facts

Evidence: nvidia_sphinx_theme-0.0.9.post1-py3-none-any.whl

Tags

More Software Development packages