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

Update to sphinx 8 on October 7th #24

Closed
cthoyt opened this issue Sep 4, 2024 · 1 comment
Closed

Update to sphinx 8 on October 7th #24

cthoyt opened this issue Sep 4, 2024 · 1 comment

Comments

@cthoyt
Copy link
Owner

cthoyt commented Sep 4, 2024

Update to sphinx 8 when RTD 3.0 theme that supports sphinx 8 comes out

readthedocs/sphinx_rtd_theme#1598 (comment)

@cthoyt
Copy link
Owner Author

cthoyt commented Sep 10, 2024

See https://about.readthedocs.com/blog/2024/07/addons-by-default/, probably need to add the following to conf.py:

import os

# Define the canonical URL if you are using a custom domain on Read the Docs
html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")

# Tell Jinja2 templates the build is running on Read the Docs
if os.environ.get("READTHEDOCS", "") == "True":
    if "html_context" not in globals():
        html_context = {}
    html_context["READTHEDOCS"] = True

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant