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

Use PyData Sphinx Theme docs version switcher #2516

Open
matthewfeickert opened this issue Jun 7, 2024 · 0 comments
Open

Use PyData Sphinx Theme docs version switcher #2516

matthewfeickert opened this issue Jun 7, 2024 · 0 comments
Assignees
Labels
docs Documentation related

Comments

@matthewfeickert
Copy link
Member

From the documentation for the theme (https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/readthedocs.html#version-switcher) the version switcher from readthedocs should still work after this is done (but won't show up before the PR is merged). If you want to use the version switcher of the PyData Sphinx Theme instead, it would require having urls for all of the previous versions of the library and one json file mapping urls to versions. This would also enable using the Version warning banner from the PyData theme itself: https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/announcements.html#version-warning-banners

From https://pyhf.readthedocs.io/en/latest/ seems like we'll need the to use the PyData Sphinx Theme version switcher.

Originally posted by @matthewfeickert in #2513 (comment)

@matthewfeickert matthewfeickert added the docs Documentation related label Jun 7, 2024
@matthewfeickert matthewfeickert self-assigned this Jun 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
None yet
Development

No branches or pull requests

1 participant