rapidsai / rapidsai/docs

Use template for rapids stable and nightly version in docs

Open
#751 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

feature request
Dominant language
HTML
Stars
52
Forks
73
Avg merge
4d 16m
Merged PRs (30d)
8

Description

Across the docs we have instances where we need need to specify rapids versions and those will change depending on if they are stable or nightly, but they will also change every time there is a release.

For example in a case like

conda create -n rapids-26.04 -c rapidsai-nightly -c conda-forge rapids=26.04 python=3.13 'cuda-version>=13.0,<=13.1.1'

In the deployment repo we do it via:

https://github.com/rapidsai/deployment/blob/4bc97baef108058700218ee173019de9f3c10d87/source/conf.py#L25-L70

https://github.com/rapidsai/deployment/blob/main/extensions/rapids_version_templating.py

Maybe something similar could help here

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the deployment repository's source/conf.py and extensions/rapids_version_templating.py, then search this docs repository for hard-coded stable and nightly RAPIDS versions. Determine how the documentation build can apply equivalent templating and verify that release changes no longer require editing each version instance manually.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.