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

Doc: use 'version_selector' instead of 'display_version' which is deprecated by sphinx-rtd-theme 3.0.0 #4270

Merged
merged 2 commits into from
Oct 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .github/workflows/doc_checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,11 @@ jobs:
steps:
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7

- name: Update sphinx-rtd-theme
shell: bash -l {0}
run: |
pip install -U "sphinx-rtd-theme>=3.0.0"

- name: Print versions
shell: bash -l {0}
run: |
Expand Down
9 changes: 2 additions & 7 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@
import sys
from datetime import date

import sphinx_rtd_theme

sys.path.insert(0, os.path.abspath("."))
sys.path.insert(0, os.path.abspath("_extensions"))

Expand Down Expand Up @@ -119,7 +117,7 @@
html_theme_options = {
"canonical_url": "https://proj.org",
"logo_only": True,
"display_version": True,
"version_selector": True,
"prev_next_buttons_location": "both",
"style_external_links": False,
"style_nav_header_background": "#353130",
Expand All @@ -131,9 +129,6 @@
"titles_only": False,
}

# Add any paths that contain custom themes here, relative to this directory
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# Display "Edit on GitHub" link on each page
# https://docs.readthedocs.io/en/stable/guides/edit-source-links-sphinx.html
html_context = {
Expand All @@ -154,7 +149,7 @@
# Add any paths that contain custom static files (such as style sheets)
html_static_path = ["_static"]

htm_css_files = [
html_css_files = [
"theme_overrides.css", # override wide tables in RTD theme
]

Expand Down
Loading