Fix Read the Docs: use build.jobs instead of build.commands #33
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
Sphinx is already installed via the dev extra requirements, so the explicit pip install is unnecessary. The key fix is using python -m sphinx.ext.apidoc instead of sphinx-apidoc command.
Using build.commands completely overrides the build process, preventing Sphinx from generating HTML output. Switch to build.jobs.pre_build to extend the build process while keeping the default Sphinx build.
acul71
force-pushed
the
fix-readthedocs-build
branch
from
63803c5 to
d67451c
Compare
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.
This PR fixes the "No HTML content found" error by switching from
build.commandstobuild.jobs.pre_build.Problem:
Using
build.commandscompletely overrides the build process, preventing Sphinx from generating HTML output to$READTHEDOCS_OUTPUT/html/.Solution:
Use
build.jobs.pre_buildto extend the build process instead of overriding it. This allows:Related: Fixes issue #31
Reference: https://docs.readthedocs.io/page/build-customization.html#where-to-put-files