DOC: add dropdown #22246
DOC: add dropdown #22246
Conversation
Just last point releases before 3.0
|
I think this will work fine on devdocs once merged. Note there is another step here for the release manager... |
doc/_static/switcher.json
Outdated
| @@ -0,0 +1,105 @@ | |||
| [ | |||
| { | |||
| "name": "stable/3.5.1", | |||
There was a problem hiding this comment.
| "name": "stable/3.5.1", | |
| "name": "3.5.1 (latest)", |
I assume it looks better in the dropdown if all entries start with version numbers. I also think that "latest" is a better description than "stable".
There was a problem hiding this comment.
Well, except the directory is stable, so we should probably follow that?
doc/_static/switcher.json
Outdated
| "version": "stable" | ||
| }, | ||
| { | ||
| "name": "devel/3.6", |
There was a problem hiding this comment.
| "name": "devel/3.6", | |
| "name": "3.6 (devel)", |
There was a problem hiding this comment.
.. and I changed this to "3.6 (devdocs)" to be consistent with my argument above ;-) However, I don't feel strongly if we should rename these.
I do hope we can merge this, just to see if it works on the devdocs. We can always fine-tune it later.
|
Which milestone do you want? |
|
Also this doesn't seem to be working on the built docs? https://66341-1385122-gh.circle-artifacts.com/0/doc/build/html/index.html |
|
It doesn't work because it requires the json to be hard coded on the web somewhere. Which merging this pr will do ;-). We could try a backport after we are sure this works. |
8d82bf6 to
38cdca0
Compare
PR Summary
This won't work because the json file needs to be hard coded versus relatively coded, and I'm also not sure we pull pydata-sphinx-theme 0.8 However, when we do, and when this gets merged into stable, it will allow a drop-down menu of version info. See https://pydata-sphinx-theme.readthedocs.io/en/latest/
PR Checklist
Tests and Styling
pytestpasses).flake8-docstringsand runflake8 --docstring-convention=all).Documentation
doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).