Align local docs builds with Read the Docs apidoc - #60
Open
acul71 wants to merge 1 commit into
Open
Conversation
Use python -m sphinx.ext.apidoc against the multibase package for docs-ci and build-docs so local Sphinx builds match the RTD pre_build job. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
Author
Demo logs (docs-ci)Local docs now use the same |
Contributor
Author
|
@sumanjeet0012 Could you please review this PR when you have a chance? Thanks! |
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
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.
Summary
Makefiledocs-ciandbuild-docsto usepython -m sphinx.ext.apidoc -o docs/ multibase, matching.readthedocs.yamlpre_buildCONTRIBUTING.rstNote: Sphinx
source_suffix/root_docand RTD pre_build were already fixed on master; this PR closes the remaining local/RTD drift.Demo / evidence
Explanation: Local CI now invokes the same module-path apidoc command as Read the Docs, with warnings as errors (
SPHINXOPTS=-W). Exit code 0.Test plan
make lintmake typecheckmake testmake docs-ci(exit 0,-W)Made with Cursor