Skip to content

Commit 0ef3d8b

Browse files
authored
Add version selector to docs (#495)
## Description <!-- Provide a brief description of the PR's purpose here. --> The ReadTheDocs version selector does not seem to work anymore. I have added the version selector that comes with the Material theme: https://bashtage.github.io/sphinx-material/customization.html?highlight=version#version-dropdown ## Status - [x] I have read the guidelines in [CONTRIBUTING.md](https://github.com/icaros-usc/pyribs/blob/master/CONTRIBUTING.md) - [x] I have formatted my code using `yapf` - [x] I have tested my code by running `pytest` - [x] I have linted my code with `pylint` - [x] I have added a one-line description of my change to the changelog in `HISTORY.md` - [x] This PR is ready to go
1 parent 5f8c639 commit 0ef3d8b

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

HISTORY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727

2828
#### Documentation
2929

30+
- Add version selector to docs ({pr}`495`)
3031
- Update gymnasium and lunar lander version ({pr}`493`)
3132
- Add tutorial page on Optuna integration ({pr}`492`)
3233
- Switch from std to var in arm tutorial ({pr}`486`)

docs/conf.py

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -170,14 +170,12 @@
170170
"index":
171171
"A bare-bones Python library for quality diversity optimization."
172172
},
173-
"version_dropdown": False,
173+
"version_dropdown": True,
174174
"version_json": None,
175-
# "version_info": {
176-
# "Release": "https://bashtage.github.io/sphinx-material/",
177-
# "Development": "https://bashtage.github.io/sphinx-material/devel/",
178-
# "Release (rel)": "/sphinx-material/",
179-
# "Development (rel)": "/sphinx-material/devel/",
180-
# },
175+
"version_info": {
176+
"Stable": "https://docs.pyribs.org/en/stable/",
177+
"Latest": "https://docs.pyribs.org/en/latest/",
178+
},
181179
"table_classes": ["plain"],
182180
}
183181

0 commit comments

Comments
 (0)