Skip to content

Switch to use nvidia-sphinx-theme #216

Closed

Description

@leofang

Activity

  1. added
    documentationImprovements or additions to documentation
    P1Medium priority - Should do
    on Nov 6, 2024
  2. leofang commented on Nov 14, 2024

    @leofang
    MemberAuthor

    I find it annoying that if we have past doc versions, all versions need to be rebuilt with the new theme... @szkarpinski I will have to peek how you did it for nvmath and other projects 😛

  3. szkarpinski commented on Nov 14, 2024

    @szkarpinski

    all versions need to be rebuilt with the new theme...

    @leofang do they? We didn't do it for DALI or nvmath. For example see the DALI docs - when you choose version <=1.38 in the switcher, you just get redirected to the docs in the old RTD theme.

  4. leofang commented on Nov 14, 2024

    @leofang
    MemberAuthor

    Yes, but it's poor UX, because the different themes look up the version json files in different places, and the file format requirements are different too. For example, if you switch to DALI 1.38 version (the last version using the old RTD theme), there's no way to select any newer versions through the version drop-down menu (except for picking main, we might argue). If we're OK with this then it is indeed straightforward as you said.

  5. leofang commented on Aug 21, 2025

    @leofang
    MemberAuthor

    @copilot please work on this:

    • This repo has multiple places (cuda components) that have sphinx conf.py. Be sure to update all of them.
    • The nvidia-sphinx-theme is derived from the pydata-sphinx-theme, so when in doubt you can look up the latter's docs. (I don't think we have the nvidia theme's docs available in the public.)
    • The versioned doc support (Enable versioned doc support #95, Prepare docs for sub-packages #165) needs update.
      • the json files probably need to be transformed into a different format
      • some JavaScripts that I added to hack the current theme can be removed now
  6. assigned and unassigned on Aug 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

P1Medium priority - Should dodocumentationImprovements or additions to documentationtriageNeeds the team's attention

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions