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

ReadTheDocs Sphinx Config Updates #417

Open
wildintellect opened this issue Jul 16, 2024 · 1 comment
Open

ReadTheDocs Sphinx Config Updates #417

wildintellect opened this issue Jul 16, 2024 · 1 comment
Assignees
Labels
bug Something isn't working

Comments

@wildintellect
Copy link
Collaborator

https://about.readthedocs.com/blog/2024/07/addons-by-default/

We are announcing the deprecation of Sphinx context injection at build time for all the projects. The deprecation date is set on Monday, October 7th, 2024. After this date, Read the Docs won't install the readthedocs-sphinx-ext extension and won't manipulate the project's conf.py file.

This will get us closer to our goal of having all projects build on Read the Docs be the exact same as on other build environments, making understanding of documentation builds much easier to understand.

You can read our blog post on the deprecation for all the information about possible impacts of this change, in particular the READTHEDOCS and other variables in the Sphinx context are no longer set automatically.
Deprecation timeline

We understand this change will affect thousands of projects, so we have a timeline to communicate this deprecation to our users effectively.

July 29, 2024: disable Sphinx context injection and enable Read the Docs Addons for all new projects created.
October 7, 2024: disable Sphinx context injection and enable Read the Docs Addons for all projects.

Are my projects affected?

You have at least one project with a canonical custom domain defined. After the deprecation date, Read the Docs will stop defining html_baseurl Sphinx configuration, which means that you will need to define it by yourself to keep the canonical custom domain properly configured.

We found the following projects where you are a maintainer are impacted by this change:

[maap-project](https://readthedocs.org/projects/maap-project/)

How I can update my projects?

You can use the following Python snippet as a guide to update your conf.py file. The snippet uses the READTHEDOCS_CANONICAL_URL environment variable to define html_baseurl and injects READTHEDOCS variable into the html_context to keep the previous behavior:

import os

Set canonical URL from the Read the Docs Domain

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":
html_context["READTHEDOCS"] = True

Closing notes

We recommend you to read the full announcement Read the Docs Addons enabled by default in our blog that contains a more detailed explanation and other similar changes that may affect other projects you maintain as well.

Contact us or reply to this email if you have any questions or feedback about this change.

@wildintellect wildintellect added the bug Something isn't working label Aug 15, 2024
@wildintellect wildintellect self-assigned this Aug 19, 2024
@rtapella rtapella self-assigned this Oct 14, 2024
wildintellect added a commit that referenced this issue Oct 15, 2024
This should resolve the RTD update compatibility.
rtapella added a commit that referenced this issue Oct 15, 2024
@wildintellect
Copy link
Collaborator Author

#443

bsatoriu added a commit that referenced this issue Oct 23, 2024
* image correction

* access method clarifications

* gis tutorial link

* reprojected

* code and wording updates

* plot updates

* s3 adjustment

* minor feedback updates

* added queue info

draft 1

* updated table with AWS instances

* Added hide and show che side panel FAQ entry

* Added intro paragraphs to each major section of the docs

* dataset

* Some clarifications

- thank you for the feedback wildintellect

* fix: update conf.py #417

This should resolve the RTD update compatibility.

* Make image grid smaller

* Reduced size of more content

* v4.1.1 (#446)

Co-authored-by: bsatoriu <[email protected]>

* typo fix (#448)

Co-authored-by: bsatoriu <[email protected]>

* typo fix (#449)

Co-authored-by: bsatoriu <[email protected]>

---------

Co-authored-by: smk0033 <[email protected]>
Co-authored-by: Rob Tapella <[email protected]>
Co-authored-by: Rob Tapella <[email protected]>
Co-authored-by: Sheyenne Kirkland <[email protected]>
Co-authored-by: Alex I. Mandel <[email protected]>
Co-authored-by: bsatoriu <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants