Skip to content

API docs setup - #51

Merged
maanug-nv merged 1 commit into
mainfrom
maanug/link-apidocs
Jun 9, 2025
Merged

maanug-nv merged 1 commit into
mainfrom
maanug/link-apidocs

Conversation

@maanug-nv

@maanug-nv maanug-nv commented Jun 6, 2025 •

Copy link
Copy Markdown
Contributor

sphinx-build is already configured to build API docs (see conf.py). Just need to include them in a toctree.

Test with:

uv run --only-group docs sphinx-autobuild docs docs/_build/html

Note, :hidden: is needed so the index/landing page does not include the entire API docs tree.

Signed-off-by: Maanu Grover <maanug@nvidia.com>
@maanug-nv
maanug-nv merged commit 732b66f into main Jun 9, 2025
@maanug-nv
maanug-nv deleted the maanug/link-apidocs branch June 9, 2025 21:51
@yaoyu-33 yaoyu-33 added docs Documentation-only updates or documentation debt and removed documentation labels Mar 10, 2026

This branch was previously deployed

2 inactive deployments
nemo-ci — 9fdee127 Deployed Jun 6, 2025 by copy-pr-bot[bot]
test — 9fdee127 Deployed Jun 6, 2025 by copy-pr-bot[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation-only updates or documentation debt

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants