Skip to content

Align local docs builds with Read the Docs apidoc - #60

Open
acul71 wants to merge 1 commit into
masterfrom
docs/issue-31-rtd-hardening
Open

Align local docs builds with Read the Docs apidoc#60
acul71 wants to merge 1 commit into
masterfrom
docs/issue-31-rtd-hardening

Conversation

@acul71

@acul71 acul71 commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Fixes Fix Read the Docs build failures #31
  • Updates Makefile docs-ci and build-docs to use python -m sphinx.ext.apidoc -o docs/ multibase, matching .readthedocs.yaml pre_build
  • Documents the local docs build command in CONTRIBUTING.rst

Note: Sphinx source_suffix / root_doc and RTD pre_build were already fixed on master; this PR closes the remaining local/RTD drift.

Demo / evidence

$ make docs-ci
python -m sphinx.ext.apidoc -o docs/ multibase
...
build succeeded.

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 lint
  • make typecheck
  • make test
  • make docs-ci (exit 0, -W)

Made with Cursor

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>
@acul71

acul71 commented Sep 7, 2026

Copy link
Copy Markdown
Contributor Author

Demo logs (docs-ci)

$ make docs-ci
python -m sphinx.ext.apidoc -o docs/ multibase
...
build succeeded.

Local docs now use the same python -m sphinx.ext.apidoc path as Read the Docs pre_build, with -W (warnings as errors). Exit code 0.

@acul71

acul71 commented Sep 7, 2026

Copy link
Copy Markdown
Contributor Author

@sumanjeet0012 Could you please review this PR when you have a chance? Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix Read the Docs build failures

1 participant