Build: do not use custom builder when DISABLE_SPHINX_MANIPULATION
#11499
Conversation
This file contains hidden or 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
We are installing `readthedocssinglehtmllocalmedia` Sphinx builder via our `readthedocs-sphinx-ext` extension. I checked that code and this builder doesn't do anything super special. It only adds a CSS file that it's related with the flyout, which it's not useful anymore: https://github.com/readthedocs/readthedocs-sphinx-ext/blob/13edf78bab374f51e314e4994c319fadbab806f2/readthedocs_ext/readthedocs.py#L81-L83 This commit runs `singlehtml` Sphinx builder (the default from Sphinx) when the `DISABLE_SPHINX_MANIPULATION` feature flag is enabled. I tested this locally using `all-formats` branch from `test-builds` and I got the same results (except from the flyout, which is not injected anymore since there is no context injected in the new behavior)
ericholscher
approved these changes
Jul 24, 2024
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.
We are installing
readthedocssinglehtmllocalmediaSphinx builder via ourreadthedocs-sphinx-extextension.I checked that code and this builder doesn't do anything super special. It only adds a CSS file that it's related with the flyout, which it's not useful anymore:
https://github.com/readthedocs/readthedocs-sphinx-ext/blob/13edf78bab374f51e314e4994c319fadbab806f2/readthedocs_ext/readthedocs.py#L81-L83
This commit runs
singlehtmlSphinx builder (the default from Sphinx) when theDISABLE_SPHINX_MANIPULATIONfeature flag is enabled. I tested this locally usingall-formatsbranch fromtest-buildsand I got the same results (except from the flyout, which is not injected anymore since there is no context injected in the new behavior)