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

1. Build the container:

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

2. Run the container from the previous step:

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

3. 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.