Build: disable Sphinx manipulation #11441
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a feature flag called `DISABLE_SPHINX_MANIPULATION` that: - don't install `readthedocs-sphinx-ext` Python package - don't append anything to the Sphinx's `conf.py` file - enable Read the Docs Addons on these versions automatically The idea behind this is start defaulting new projects to Read the Docs Addons without breaking old projects. This is a potential first step in favor of the full deprecation/removal of the Sphinx manipulation (as we already did for MkDocs). Once this happens, **building on Read the Docs will produce the exact same result than building locally**. Related readthedocs/addons#72
This is a useful variable that we will require during the deprecation of the Sphinx context manipulation. Besides, it seems a useful variable that we should expose to users anyways so they can use it as relative to calculate other useful paths.
ericholscher
reviewed
Jul 2, 2024
| @@ -654,6 +662,7 @@ def get_rtd_env_vars(self): | |||
| # "READTHEDOCS_GIT_HTML_URL": self.data.project.remote_repository.html_url, | |||
| "READTHEDOCS_GIT_IDENTIFIER": self.data.version.identifier, | |||
| "READTHEDOCS_GIT_COMMIT_HASH": self.data.build["commit"], | |||
| "READTHEDOCS_PRODUCTION_DOMAIN": settings.PRODUCTION_DOMAIN, | |||
There was a problem hiding this comment.
This kinda feels like an internal thing, especially not documenting it. I assume it's needed for something downstream?
There was a problem hiding this comment.
This is required by the sphinx-build-compatibility extension to know if we have to perform the APIv2 call to community or business. I may miss the documentation for this, but I will add it in that case. Seems useful to pass it to the build commands.
…mitos/disable-sphinx-manipulation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a feature flag called
DISABLE_SPHINX_MANIPULATIONthat:readthedocs-sphinx-extPython packageconf.pyfileThe idea behind this is start defaulting new projects to Read the Docs Addons without breaking old projects.
This is a potential first step in favor of the full deprecation/removal of the Sphinx manipulation (as we already did for MkDocs). Once this happens, building on Read the Docs will produce the exact same result than building locally.
As you can see in the screenshots, the build process doesn't install the
readthedocs-sphinx-extanymore and doesn't append anything to the Sphinx'sconf.pyfile. Besides, when loading the documentation, the addons are already enabled and showing the new expected behavior.Related readthedocs/addons#72