{"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.","language":"python","status":"active","last_verified":"Thu Apr 16","install":{"commands":["pip install nvidia-sphinx-theme"],"cli":null},"imports":["html_theme = 'nvidia_sphinx_theme'"],"auth":{"required":false,"env_vars":[]},"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).","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}