RTD maintenance #269
RTD maintenance #269
Conversation
Changes based on email from RTD:
[Action required] Deprecation: Removal of Sphinx context injection at build time
And the following one blog post:
https://about.readthedocs.com/blog/2024/07/addons-by-default/
| 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": |
There was a problem hiding this comment.
Nit: the default value for the default parameter is None, no need to tweak it here.
| if os.environ.get("READTHEDOCS", "") == "True": | |
| if os.environ.get("READTHEDOCS") == "True": |
There was a problem hiding this comment.
It's from their docs, so didn't tweak it. Will leave as is.
(Wonder if there's some type-checking background to passing "" as default. (without it's typed as Optional[str], with it's str).
| @@ -143,6 +143,15 @@ | |||
|
|
|||
| html_theme = 'sphinx_rtd_theme' | |||
|
|
|||
| # Set canonical URL from the Read the Docs Domain | |||
| html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "") | |||
There was a problem hiding this comment.
Do we actually need to set this? Asking since we do not currently set it for the Spicy docs.
There was a problem hiding this comment.
Hmm.. the email said:
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:
The docs you linked might be dated?
Spicy is a subproject of Zeek, so maybe there pre-notification hasn't detected that, or it's not needed for subprojects (though that would be confusing, too).
|
Custom build here: https://docs.zeek.org/en/topic-awelzel-readthedocs-maintenance/index.html Skimming looks okay. |
No description provided.