Skip to content

docs: include docs dependency group in live build command - #901

Open
himanshu748 wants to merge 1 commit into
simonw:mainfrom
himanshu748:docs/include-docs-group-livehtml
Open

himanshu748 wants to merge 1 commit into
simonw:mainfrom
himanshu748:docs/include-docs-group-livehtml

Conversation

@himanshu748

@himanshu748 himanshu748 commented Oct 11, 2026 •

Copy link
Copy Markdown

Fixes #900.

Add --group docs to the contributor guide's live documentation command, matching the existing Justfile recipe. In a fresh environment, the old command exits 2 with sphinx-autobuild: not found because the default development dependencies do not include it.

Verified on Linux with Python 3.12.14 and uv 0.12.23:

  • The corrected live build succeeds and serves the contributor guide with HTTP 200.
  • uv run --group docs sphinx-build -W -b html docs /tmp/sqlite-docs-build
  • uv run --group docs codespell docs/*.rst --ignore-words docs/codespell-ignore-words.txt
  • uv run cog --check --diff README.md docs/*.rst
  • git diff --check

The optional nitpicky Sphinx check (-n -W) has 188 identical unresolved-reference warnings on the original and patched trees. The normal -W build passes.

OpenAI Codex assisted with reproduction, the one-line correction, testing, and this description. Human review remains pending.


📚 Documentation preview 📚: https://sqlite-utils--901.org.readthedocs.build/en/901/

@himanshu748
himanshu748 marked this pull request as ready for review October 11, 2026 00:23
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 11, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-11T00:24:48.962646Z b6b5b99 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

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.

Contributor docs build command omits the docs dependency group

1 participant