Fix Read the Docs build: generate API docs before Sphinx build #56
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
- Add build command to run sphinx-apidoc before Sphinx processes docs - Use -f flag to force overwrite existing files - Fixes warning: 'toctree contains reference to nonexisting document cid' This ensures Read the Docs generates the API documentation files before Sphinx tries to build them, matching the local build process.
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.
Fixes Read the Docs build failure reported in build #30752702.
Problem
Read the Docs build was failing with:
The build failed because
cid.rstwasn't generated before Sphinx tried to process it.Solution
.readthedocs.ymlto runsphinx-apidocbefore Sphinx processes the documentation-fflag to force overwrite existing filesChanges
build.commandssection to.readthedocs.ymlsphinx-apidoc -o docs/ --separate --no-toc -f cidThis matches the local build process in the Makefile and ensures Read the Docs can successfully build the documentation.