Skip to content

Commit 371126e

Browse files
DOC: Section on RTD version switcher (#1280)
* DOC: Section on RTD version switcher * Apply suggestions from code review * remove hash --------- Co-authored-by: Vecko <[email protected]> Co-authored-by: Daniel McCloy <[email protected]>
1 parent a55cb93 commit 371126e

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/user_guide/readthedocs.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
This theme comes with support for {{ rtd }}, a popular service for hosting documentation in the scientific Python community.
44

5+
## Version switcher
6+
7+
Projects hosted on {{ rtd }} can use the {{ rtd }} supplied version switcher instead of the [version switcher that this theme provides](version-dropdown.rst).
8+
Its presence will be automatically detected by this theme, and placed in the `rtd-footer-container` node inside the primary sidebar.
9+
10+
```{warning}
11+
The {{ rtd }} version switcher will be hidden any time the primary sidebar is hidden (see [this section](layout-sidebar-primary) for discussion of when the primary sidebar might get hidden automatically and how to hide it purposely).
12+
We intend to make {{ rtd }} switcher placement more flexible; you can track progress toward that in [this issue](https://github.com/pydata/pydata-sphinx-theme/issues/705).
13+
```
14+
515
## Add ethical advertisements to your sidebar
616

717
If you're hosting your documentation on ReadTheDocs, you should consider

0 commit comments

Comments
 (0)