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.

Sign up for GitHub

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

Jump to bottom

DOC: Section on RTD version switcher #1280

Merged
merged 3 commits into from
Apr 11, 2023
Merged

DOC: Section on RTD version switcher #1280

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b68b1f6
DOC: Section on RTD version switcher
VeckoTheGecko Apr 5, 2023
12c3939
Apply suggestions from code review
drammock Apr 11, 2023
2030fe6
remove hash
drammock Apr 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/user_guide/readthedocs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@

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

## Version switcher

Projects hosted on {{ rtd }} can use the {{ rtd }} supplied version switcher instead of the [version switcher that this theme provides](version-dropdown.rst).
Its presence will be automatically detected by this theme, and placed in the `rtd-footer-container` node inside the primary sidebar.

```{warning}
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).
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).
```

## Add ethical advertisements to your sidebar

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