{"id":9144,"library":"nvidia-sphinx-theme","title":"NVIDIA Sphinx Theme","description":"The `nvidia-sphinx-theme` provides a modern, opinionated Sphinx theme specifically designed for NVIDIA projects, focusing on clean aesthetics and user experience. It is currently at version 0.0.9.post1 and follows an irregular release cadence, with updates typically coinciding with feature additions or Sphinx compatibility requirements.","status":"active","version":"0.0.9.post1","language":"en","source_language":"en","source_url":"https://github.com/NVIDIA/nvidia-sphinx-theme","tags":["sphinx","theme","documentation","nvidia","readthedocs"],"install":[{"cmd":"pip install nvidia-sphinx-theme","lang":"bash","label":"Install latest version"}],"dependencies":[{"reason":"The theme is an extension for Sphinx and requires Sphinx 6.x or newer to build documentation.","package":"sphinx","optional":false}],"imports":[{"note":"The theme is configured by setting `html_theme` in your Sphinx `conf.py` file, not by a standard Python import statement.","symbol":"html_theme","correct":"html_theme = 'nvidia_sphinx_theme'"}],"quickstart":{"code":"# conf.py\n\nimport os\nimport sys\n\n# -- Project information -----------------------------------------------------\nproject = 'My NVIDIA Docs'\ncopyright = '2023, NVIDIA'\nauthor = 'NVIDIA'\n\n# -- General configuration ---------------------------------------------------\nextensions = [\n    'sphinx.ext.autodoc',\n    'sphinx.ext.napoleon',\n    'sphinx.ext.viewcode'\n]\n\ntemplates_path = ['_templates']\nexclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']\n\n# -- Options for HTML output -------------------------------------------------\nhtml_theme = 'nvidia_sphinx_theme'\nhtml_static_path = ['_static']\n\n# Theme options are specific to the theme. Consult the theme's documentation\n# for options available. For example:\n# html_theme_options = {\n#     \"navbar_left_text\": \"NVIDIA\",\n#     \"logo_link\": \"https://www.nvidia.com\",\n# }","lang":"python","description":"To quickly start a project with the NVIDIA Sphinx theme:\n1. Create a new Sphinx project using `sphinx-quickstart`.\n2. Install the theme: `pip install nvidia-sphinx-theme`.\n3. Replace the content of your generated `conf.py` with the example above, or modify `html_theme` to `'nvidia_sphinx_theme'`.\n4. Build your documentation: `make html` (or `sphinx-build -b html . _build` on Windows or if `make` isn't available)."},"warnings":[{"fix":"Ensure your Sphinx installation is `sphinx>=6.0.0`. You can upgrade with `pip install --upgrade sphinx`.","message":"The `nvidia-sphinx-theme` requires Sphinx version 6.x or newer. Using older versions of Sphinx will result in build errors or incorrect rendering.","severity":"breaking","affected_versions":"< 0.0.1 (any version of theme with Sphinx < 6.x)"},{"fix":"Upgrade your Python environment to 3.10 or newer. Check your Python version with `python --version`.","message":"Python 3.10 or newer is required to install and use `nvidia-sphinx-theme`. Attempting to install on older Python versions will fail.","severity":"gotcha","affected_versions":"All versions when used with Python < 3.10"},{"fix":"Activate your virtual environment before running `pip install nvidia-sphinx-theme` and `sphinx-build`.","message":"If you are running `sphinx-build` inside a virtual environment, ensure `nvidia-sphinx-theme` is installed within that specific environment. If it's installed globally but not in the active venv, Sphinx will not find it.","severity":"gotcha","affected_versions":"All versions"}],"env_vars":null,"last_verified":"2026-04-16T00:00:00.000Z","next_check":"2026-07-15T00:00:00.000Z","problems":[{"fix":"Run `pip install nvidia-sphinx-theme` in your active Python environment. If using a virtual environment, ensure it is activated.","cause":"The `nvidia-sphinx-theme` package has not been installed in the Python environment where Sphinx is being run, or the environment is not active.","error":"sphinx.errors.ThemeError: The 'nvidia_sphinx_theme' theme is not installed."},{"fix":"Upgrade your Python environment to version 3.10 or newer. Consider using a tool like `pyenv` or `conda` to manage multiple Python versions.","cause":"Your current Python version (X.Y.Z) is older than the minimum required version (3.10) for `nvidia-sphinx-theme`.","error":"ERROR: Package 'nvidia-sphinx-theme' requires a different Python: X.Y.Z is not in '>=3.10'"},{"fix":"Upgrade Sphinx to version 6.x or newer. Run `pip install --upgrade sphinx`.","cause":"This error can occur when using an older Sphinx version (e.g., Sphinx 5.x) with a theme designed for Sphinx 6.x or newer, due to changes in how Sphinx accesses version information.","error":"TypeError: 'version_info' object is not subscriptable"}]}