chore: Adding in standard OSS NVIDIA Sphinx install#139
Merged
dagardner-nv merged 9 commits intoNVIDIA-AI-Blueprints:developfrom Mar 17, 2026
Merged
chore: Adding in standard OSS NVIDIA Sphinx install#139dagardner-nv merged 9 commits intoNVIDIA-AI-Blueprints:developfrom
dagardner-nv merged 9 commits intoNVIDIA-AI-Blueprints:developfrom
Conversation
Signed-off-by: Andrew Schilling <aschilling@nvidia.com>
Contributor
Greptile SummaryThis PR migrates the Sphinx documentation setup to the standard NVIDIA OSS Sphinx theme ( Key changes:
Outstanding concerns (some already discussed in previous threads):
Confidence Score: 3/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant Browser
participant DocsServer as docs.nvidia.com/ai-blueprint/1.2.1/
participant VersionJSON as versions1.json location
Browser->>DocsServer: Load page
DocsServer-->>Browser: HTML + PyData theme JS
Browser->>VersionJSON: GET ../versions1.json<br/>(resolves to docs.nvidia.com/ai-blueprint/versions1.json)
note over VersionJSON: ⚠️ File is actually served at<br/>docs.nvidia.com/ai-blueprint/1.2.1/versions1.json<br/>(placed there by html_extra_path)
VersionJSON-->>Browser: 404 Not Found
Browser->>Browser: Version switcher widget fails to populate
Last reviewed commit: 8f0756f |
Signed-off-by: Andrew Schilling <aschilling@nvidia.com>
Collaborator
|
@aschilling-nv can you resolve lint issues in ci |
Signed-off-by: Andrew Schilling <aschilling@nvidia.com>
Signed-off-by: Andrew Schilling <aschilling@nvidia.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Contributor
Author
Done! |
…s/docs-support Signed-off-by: David Gardner <dagardner@nvidia.com>
dagardner-nv
approved these changes
Mar 17, 2026
Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
Collaborator
|
/merge |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
standard NVIDIA OSS Sphinx theme (
nvidia_sphinx_theme) as the required themedocs/source/conf.pywith additional extensions (sphinx.ext.viewcode,sphinx.ext.napoleon,sphinx_design), richer MyST parser options (math, task lists,definition lists, etc.), and Mermaid diagram configuration
project.jsonandversions1.jsonto support the NVIDIA docs version switcherwidget and public docs features
pyproject.tomldoc dependencies:nvidia-sphinx-theme,sphinx-autobuild,sphinx-design, andsphinxcontrib-mermaidlinkcheck_ignoreto skip GitHub and raw GitHub URLs during link checks