-
Notifications
You must be signed in to change notification settings - Fork 751
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Update ReadTheDocs builds configuration #11179
Merged
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
Build Artifacts
|
ReadTheDocs will soon stop supporting projects with no configuration file. https://blog.readthedocs.com/migrate-configuration-v2/
The theme was previously enabled only for local builds, probably because it was applied by default by ReadTheDocs before they started shifting towards requiring explicit configuration in general.
rtibbles
reviewed
Sep 15, 2023
rtibbles
approved these changes
Sep 15, 2023
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Labels
DEV: backend
Python, databases, networking, filesystem...
SIZE: small
TAG: developer docs
Technical docs and code comments
TODO: needs review
Waiting for review
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.
Summary
sphinx-rtd-theme
for the production buildReferences
https://blog.readthedocs.com/migrate-configuration-v2/
Reviewer guidance
Testing checklist
If there are any front-end changes, before/after screenshots are includedCritical user journeys are covered by Gherkin storiesCritical and brittle code paths are covered by unit testsPR process
If this is an important user-facing change, PR or related issue has a 'changelog' labelIf this includes an internal dependency change, a link to the diff is providedReviewer checklist
yarn
andpip
)