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

Move docs version switcher to navigation bar #2386

Closed
cosenal opened this issue May 24, 2024 Discussed in #2383 · 1 comment
Closed

Move docs version switcher to navigation bar #2386

cosenal opened this issue May 24, 2024 Discussed in #2383 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers non-quantum Requires no knowledge of quantum physics to fix / work on. priority/low A non-urgent issue to fix or idea to discuss.

Comments

@cosenal
Copy link
Contributor

cosenal commented May 24, 2024

Discussed in #2383

Originally posted by purva-thakre May 23, 2024
https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/version-dropdown.html

RTD allows us to switch between earlier versions of mitiq's documentation. The ability to switch between earlier versions is not as easily accessible unless we scroll down to the bottom of each page and look at the bottom left corner.
image

This option is also not available on certain pages like https://mitiq.readthedocs.io/en/stable/

With the PyData theme, there is a convenient option of using a version switcher in the header/navigation bar.

image

@cosenal cosenal added documentation Improvements or additions to documentation non-quantum Requires no knowledge of quantum physics to fix / work on. good first issue Good for newcomers labels May 24, 2024
@cosenal cosenal changed the title Add a version switcher for the docs Move docs version switcher to navigation bar May 24, 2024
@purva-thakre purva-thakre self-assigned this Jul 1, 2024
@purva-thakre purva-thakre added this to the 0.39.0 milestone Jul 1, 2024
@cosenal cosenal added the priority/low A non-urgent issue to fix or idea to discuss. label Jul 5, 2024
@cosenal cosenal removed this from the 0.39.0 milestone Jul 5, 2024
@purva-thakre purva-thakre removed their assignment Oct 1, 2024
@purva-thakre
Copy link
Contributor

Closing this as we don't need to worry about the placement of the different build versions that much.

Newer version of RTD has put these in a conveniently accessible spot (bottom right).

image

@purva-thakre purva-thakre closed this as not planned Won't fix, can't repro, duplicate, stale Oct 8, 2024
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 good first issue Good for newcomers non-quantum Requires no knowledge of quantum physics to fix / work on. priority/low A non-urgent issue to fix or idea to discuss.
Projects
None yet
Development

No branches or pull requests

2 participants