We are reworking how we version our docs as we migrate to docs.nvidia.com. Going forward, we will have latest and CalVer tags like 26.08, 26.10, etc.
Published documentation should have Intersphinx links to docs of the corresponding release, and should not contain links to moving inventories like latest. This issue proposes to configure documentation so builds from main use latest, while builds from release/YY.MM use the matching YY.MM inventory.
This depends on rapidsai/shared-workflows#625, which publishes /YY.MM/ documentation as soon as a release branch exists while keeping it out of versions.json until the final vYY.MM.PP tag exists. rapidsai/shared-workflows#624 provides the corresponding latest and released-version switcher behavior.
Required behavior
- On
main, Intersphinx mappings use https://docs.nvidia.com/<project>/latest/.
- On
release/YY.MM, mappings use https://docs.nvidia.com/<project>/YY.MM/.
- Each repository's
ci/release/update-version.sh maintains the appropriate URLs for both --run-context=main and --run-context=release.
- Archived
/YY.MM/ docs contain no Intersphinx links to moving stable or latest targets.
- Documentation builds verify that each configured inventory can be fetched.
UCXX is versioned independently from other libraries. Its release updater must use NEXT_RAPIDS_SHORT_TAG for RAPIDS documentation URLs, not UCXX's NEXT_SHORT_TAG.
Inventory
The following documentation packages in local checkouts have Intersphinx references to other projects:
The resulting dependency graph is acyclic:
- RMM → cuDF → dask-cuDF
- Dask-CUDA → dask-cuDF
- RMM and cuDF → cuML
- RMM and cuDF → UCXX
Tracking
We are reworking how we version our docs as we migrate to docs.nvidia.com. Going forward, we will have
latestand CalVer tags like26.08,26.10, etc.Published documentation should have Intersphinx links to docs of the corresponding release, and should not contain links to moving inventories like
latest. This issue proposes to configure documentation so builds frommainuselatest, while builds fromrelease/YY.MMuse the matchingYY.MMinventory.This depends on rapidsai/shared-workflows#625, which publishes
/YY.MM/documentation as soon as a release branch exists while keeping it out ofversions.jsonuntil the finalvYY.MM.PPtag exists. rapidsai/shared-workflows#624 provides the correspondinglatestand released-version switcher behavior.Required behavior
main, Intersphinx mappings usehttps://docs.nvidia.com/<project>/latest/.release/YY.MM, mappings usehttps://docs.nvidia.com/<project>/YY.MM/.ci/release/update-version.shmaintains the appropriate URLs for both--run-context=mainand--run-context=release./YY.MM/docs contain no Intersphinx links to movingstableorlatesttargets.UCXX is versioned independently from other libraries. Its release updater must use
NEXT_RAPIDS_SHORT_TAGfor RAPIDS documentation URLs, not UCXX'sNEXT_SHORT_TAG.Inventory
The following documentation packages in local checkouts have Intersphinx references to other projects:
The resulting dependency graph is acyclic:
Tracking