Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch to use nvidia-sphinx-theme #216

Open
leofang opened this issue Nov 6, 2024 · 3 comments
Open

Switch to use nvidia-sphinx-theme #216

leofang opened this issue Nov 6, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation P1 Medium priority - Should do triage Needs the team's attention

Comments

@leofang
Copy link
Member

leofang commented Nov 6, 2024

It's finally up on PyPI now: https://pypi.org/project/nvidia-sphinx-theme

@leofang leofang added documentation Improvements or additions to documentation P1 Medium priority - Should do labels Nov 6, 2024
@leofang
Copy link
Member Author

leofang commented Nov 14, 2024

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 😛

@szkarpinski
Copy link

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.

@leofang
Copy link
Member Author

leofang commented Nov 14, 2024

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.

@leofang leofang added the triage Needs the team's attention label Jan 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation P1 Medium priority - Should do triage Needs the team's attention
Projects
None yet
Development

No branches or pull requests

3 participants