Skip to content

Commit 9155c23

Browse files
updating files based on sphinx warning during documentation build (NVIDIA-AI-Blueprints#459)
* updating files based on sphinx warning during documentation build * Update docs/deploy-helm.md Co-authored-by: nkmcalli <nkmcalli@yahoo.com> --------- Co-authored-by: nkmcalli <nkmcalli@yahoo.com>
1 parent 570d47a commit 9155c23

6 files changed

Lines changed: 12 additions & 9 deletions

File tree

docs/api-rag.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ This documentation contains the OpenAPI reference for the RAG server.
1010
:::{tip}
1111
To view this documentation on docs.nvidia.com, browse to [https://docs.nvidia.com/rag/latest/api-rag](https://docs.nvidia.com/rag/latest/api-rag.html).
1212
:::
13-
=======
14-
To view this documentation on docs.nvidia.com, browse to [https://docs.nvidia.com/rag/latest/api-rag](https://docs.nvidia.com/rag/latest/api-rag.html).
1513

1614

1715
:::{swagger-plugin} ../docs/api_reference/openapi_schema_rag_server.json

docs/conf.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,9 @@
7474
"icon": "fa-brands fa-github",
7575
}
7676
],
77-
"switcher": {"json_url": "../versions1.json", "version_match": release},
77+
# Path is resolved from the Sphinx conf directory (docs/). ../versions1.json
78+
# points at the repo root and breaks local builds; versions1.json lives in docs/.
79+
"switcher": {"json_url": "versions1.json", "version_match": release},
7880
"extra_head": {
7981
"""
8082
<script src="https://assets.adobedtm.com/5d4962a43b79/c1061d2c5e7b/launch-191c2462b890.min.js" ></script>

docs/deploy-helm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ To deploy End-to-End RAG Server and Ingestor Server, use the following procedure
125125
Refer to [NIM Model Profile Configuration](model-profiles.md) for using non-default NIM LLM profile.
126126
:::
127127

128-
For **Nemotron 3 Super** on Helm, see the [Nemotron 3 Super deployment guide](nemotron3-super-deployment.md#helm-deployment-nemotron-3-super).
128+
For **Nemotron 3 Super** on Helm, see the [Nemotron 3 Super deployment guide](helm-deployment-nemotron-3-super).
129129

130130

131131
## Verify a Deployment

docs/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ For detailed requirements, refer to [Support Matrix](support-matrix.md).
4949

5050
- [Deploy with Docker (Self-Hosted Models)](deploy-docker-self-hosted.md)
5151
- [Deploy with Docker (NVIDIA-Hosted Models)](deploy-docker-nvidia-hosted.md)
52+
- [Nemotron 3 Super (120B) deployment](nemotron3-super-deployment.md)
5253
- [Deploy on Kubernetes with Helm](deploy-helm.md)
5354
- [Deploy on Kubernetes with Helm from the repository](deploy-helm-from-repo.md)
5455
- [Deploy on Kubernetes with Helm and MIG Support](mig-deployment.md)
@@ -167,7 +168,6 @@ After you deploy the RAG blueprint, you can customize it for your use cases.
167168
:hidden:
168169
169170
Get an API Key <api-key.md>
170-
Get Started with the RAG Blueprint <deploy-docker-self-hosted.md>
171171
Web User Interface <user-interface.md>
172172
Use the RAG Python Package <python-client.md>
173173
Notebooks <notebooks.md>
@@ -182,6 +182,7 @@ After you deploy the RAG blueprint, you can customize it for your use cases.
182182
183183
Deploy with Docker (Self-Hosted Models) <deploy-docker-self-hosted.md>
184184
Deploy with Docker (NVIDIA-Hosted Models) <deploy-docker-nvidia-hosted.md>
185+
Nemotron 3 Super deployment <nemotron3-super-deployment.md>
185186
Deploy on Kubernetes with Helm <deploy-helm.md>
186187
Deploy on Kubernetes with Helm from the repository <deploy-helm-from-repo.md>
187188
Deploy on Kubernetes with Helm and MIG Support <mig-deployment.md>

docs/nemotron3-super-deployment.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ export PROMPT_CONFIG_FILE=$(pwd)/deploy/compose/nemotron3-super-prompt.yaml
7878

7979
Check the [model page](https://build.nvidia.com/nvidia/nemotron-3-super-120b-a12b/modelcard) for more details.
8080

81-
> Note: For RTX 6000 Pro GPUs, additional NIM environment variables are required — see [RTX 6000 Pro](#rtx-6000-pro) below.
81+
> Note: For RTX 6000 Pro GPUs, additional NIM environment variables are required — see [RTX 6000 Pro](rtx-6000-pro) below.
8282
8383
2. Set nemotron-3-super specific environment variables.
8484

@@ -93,7 +93,8 @@ export PROMPT_CONFIG_FILE=$(pwd)/deploy/compose/nemotron3-super-prompt.yaml
9393

9494
Follow [Start services using self-hosted on-premises models](deploy-docker-self-hosted.md#start-services-using-self-hosted-on-premises-models) to start the vectorstore, rag-server, NIMs, and ingestor-server.
9595

96-
**RTX 6000 Pro**
96+
(rtx-6000-pro)=
97+
### RTX 6000 Pro
9798

9899
> Note: To deploy TP2 profiles on RTX PRO 6000 Blackwell Server Edition, run the following commands. You don't need to go through these steps if you are using TP4 or TP8 profile.
99100
@@ -120,6 +121,7 @@ export PROMPT_CONFIG_FILE=$(pwd)/deploy/compose/nemotron3-super-prompt.yaml
120121
121122
---
122123
124+
(helm-deployment-nemotron-3-super)=
123125
## Helm deployment (`nemotron-3-super-120b-a12b`)
124126

125127
From the repository root, run:
@@ -136,7 +138,7 @@ helm upgrade --install rag -n rag https://helm.ngc.nvidia.com/nvidia/blueprint/c
136138

137139
The prompt file `deploy/compose/nemotron3-super-prompt.yaml` is tuned for `nemotron-3-super-120b-a12b`. To customize it, see [Prompt customization in Helm chart](prompt-customization.md#prompt-customization-in-helm-chart).
138140

139-
**RTX 6000 Pro**
141+
### RTX 6000 Pro (Helm)
140142

141143
> Note: To deploy TP2 profiles on RTX PRO 6000 Blackwell Server Edition, run the following commands. You don't need to go through these steps if you are using TP4 or TP8 profile.
142144

docs/release-notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ This release includes the following key updates:
3030
- **Added MIG support for RTX 6000.** For details, refer to [MIG Deployment](mig-deployment.md) and use `values-mig-rtx6000.yaml` and `mig-config-rtx6000.yaml`.
3131
- Added documentation for the experimental Nemotron-parse-only ingestion pipeline. This configuration allows you to perform extraction using only Nemotron Parse through NV-Ingest, without relying on OCR, page-elements, graphic-elements, or table-structure NIMs. For more information, refer to [nemotron-parse-extraction.md](nemotron-parse-extraction.md#experimental-nemotron-parse-only-extraction).
3232
- Several bug fixes, including frontend CVE resolutions, improved multimodal content concatenation for VLM embeddings, enhanced VDB serialization for high-concurrency parallel ingestion, and updates to observability and NeMo Guardrails configurations.
33-
- Added agentic skills support: the `rag-blueprint` skill enables AI coding assistants (Claude Code, Cursor, Codex, etc.) to deploy, configure, troubleshoot, and manage the RAG Blueprint autonomously. For details, refer to [RAG Blueprint Agent Skill](../skill-source/README.md).
33+
- Added agentic skills support: the `rag-blueprint` skill enables AI coding assistants (Claude Code, Cursor, Codex, etc.) to deploy, configure, troubleshoot, and manage the RAG Blueprint autonomously. For details, refer to [RAG Blueprint Agent Skill](https://github.com/NVIDIA-AI-Blueprints/rag/blob/main/skill-source/README.md).
3434
- Added [accuracy benchmark results](accuracy-benchmarks.md) across seven public datasets (RagBattlepacket, KG-RAG, Financebench, DC767, HotPotQA, Google Frames, and Vidore), comparing LLM and VLM configurations with reasoning on/off. Benchmarks use the NVIDIA Answer Accuracy metric from RAGAS.
3535

3636
### Fixed Known Issues

0 commit comments

Comments
 (0)