Skip to content

Add feature flag to use the stock Sphinx builders #7141

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

Merged
merged 2 commits into from
Jun 3, 2020

Conversation

davidfischer
Copy link
Contributor

@davidfischer davidfischer commented May 29, 2020

Adds a feature flag to use the built-in Sphinx builders (html, dirhtml, singlehtml) instead of the Read the Docs customized builders (readthedocs, readthedocsdirhtml, readthedocssinglehtml).

This is OK to merge without readthedocs/readthedocs-sphinx-ext#88 but the feature flag should not be turned on for any projects before that is merged. We conditionally include some files only for our builders but not for some other files and people will get a broken experience.

Closes #5359

@davidfischer davidfischer requested a review from a team May 29, 2020 00:19
@davidfischer
Copy link
Contributor Author

The test failure looks unrelated.

@stsewd
Copy link
Member

stsewd commented May 29, 2020

yeah, flaky test is back.. Trying to get it fixed now

Copy link
Member

@humitos humitos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Big 👍 on using default Sphinx builders'. This allows extensions that check for default names to work under Read the Docs.

@davidfischer davidfischer merged commit 6b32b39 into master Jun 3, 2020
@davidfischer davidfischer deleted the davidfischer/feature-flag-use-stock-builders branch June 3, 2020 22:41
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

Successfully merging this pull request may close these issues.

Don't include searchbox in singlehtml builds
3 participants