docs

RAG Documentation

The Generative AI Examples documentation is available from https://nvidia.github.io/GenerativeAIExamples/latest/.

Build the container:

docker build --pull \
  --tag genai-docs:0.1.0 \
  --file docs/Dockerfile .

Run the container from the previous step:

docker run -it --rm \
  -v $(pwd):/work -w /work \
  genai-docs:0.1.0 \
  bash

Build the docs:
```
sphinx-build -E -a -b html -d /tmp docs docs/_build/output
```
The documentation is viewable in your browser with a URL like file://.../docs/_build/latest/.

Update docs/versions.json and docs/project.json to include the new version.

After the content is finalized, tag the commit to publish with v and a semantic version, such as v0.6.0.

If post-release updates are required, tag those commits like v0.6.0-1.

If post-release updates to an older version are required, ensure the commit message includes /not-latest. Then tag the commit like v0.5.0-1.

Run a linkcheck build:

sphinx-build -b linkcheck -d /tmp docs docs/_build/output | grep broken

Artificial URLs like https://host-ip are reported as broken, so perfection is not possible.

Name	Name	Last commit message	Last commit date
parent directory ..
api_reference	api_reference
developer-llm-operator	developer-llm-operator
images	images
media	media
templates	templates
Dockerfile	Dockerfile
README.md	README.md
api-catalog.md	api-catalog.md
architecture.md	architecture.md
chain-server.md	chain-server.md
conf.py	conf.py
configuration.md	configuration.md
evaluation.md	evaluation.md
frontend.md	frontend.md
hf_model_download.md	hf_model_download.md
index.md	index.md
jupyter-server.md	jupyter-server.md
llm-inference-server.md	llm-inference-server.md
local-gpu.md	local-gpu.md
multi-gpu.md	multi-gpu.md
multi-turn.md	multi-turn.md
multimodal-data.md	multimodal-data.md
observability.md	observability.md
project.json	project.json
quantized-llm-model.md	quantized-llm-model.md
query-decomposition.md	query-decomposition.md
requirements.txt	requirements.txt
structured-data.md	structured-data.md
support-matrix.md	support-matrix.md
swagger-requirements.txt	swagger-requirements.txt
using-sample-web-application.md	using-sample-web-application.md
vector-database.md	vector-database.md
versions.json	versions.json