Add support for --readthedocs on init
#2555
Open
+142
−1
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
🦋 Changeset detectedLatest commit: 351c394 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
mfisher87
reviewed
Dec 4, 2025
Co-authored-by: Matt Fisher <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Landing here after trying to publish a Jupyter Book site to ReadTheDocs.
There is already some documentation for GitHub Pages here: https://jupyterbook.org/stable/get-started/publish/#github-pages. And while ReadTheDocs is mentioned in the docs, there didn't seem to be the equivalent for ReadTheDocs.
So this PR adds a new
--readthedocsflag so it's easier to get the config right. Especially as the last line (rm -rf _build) seems to be important on ReadTheDocs.