Skip to content

Declare autohttp extensions safe for parallel reading - #156

Open
ANO3457 wants to merge 1 commit into
sphinx-contrib:mainfrom
ANO3457:fix/autohttp-parallel-read-clean-15
Open

ANO3457 wants to merge 1 commit into
sphinx-contrib:mainfrom
ANO3457:fix/autohttp-parallel-read-clean-15

Conversation

@ANO3457

@ANO3457 ANO3457 commented Oct 25, 2026

Copy link
Copy Markdown

Clean-history replacement for #154, following the maintainer's invitation. Fixes #15.

Bottle, Flask, Flask quick-reference and Tornado autohttp setup functions now declare parallel_read_safe. The directives use document-local nodes and the HTTP domain's existing merge/clear behavior. Includes a changelog entry.

The new branch starts directly at current main 32c21562d85d3accf4f06a0a88a1b24f92089ce5 and contains exactly one feature commit, 144e0eacc161a5514bd974362064e08510290078. Only the four setup functions, the regression test and CHANGELOG.rst differ. The former feature commits are not ancestors of this branch; .gitignore, editor files, fonts, public assets and workflows have no diff.

The regression builds six pages from real Bottle/Flask/Tornado app objects. It checks warning-free serial and parallel Sphinx builds, multiple actual worker environment merges on Linux, identical HTTP inventories/HTML links, and incremental removal of one route. The original base fails the four missing-metadata cases.

Exact-product Linux validation, using the repository's locked tox targets:

  • Python 3.10: 16 passed, including the wheel smoke test.
  • Python 3.11/3.12/3.13/3.14/3.15: each 15 passed, 1 intentional Python-3.10-only wheel-smoke skip.
  • Warning-as-error documentation builds passed in all six environments.
  • Minimum Sphinx 8.1.3 smoke and linkcheck also passed; all eight validation jobs succeeded.
  • Local Windows Python 3.13/Sphinx 9.2: 15 passed, 1 wheel skip, docs -W passed. Linux supplies the actual parallel-reader proof.
  • The validation also asserts the single-parent feature history and absence of unrelated path changes. The fork-only helper workflow is excluded from this PR.

This does not change routing-table label registration in #153 or quick-reference path ordering from the former #155.

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 sphinxcontrib-httpdomain | 🛠️ Build #35387092 | 📁 Comparing 144e0ea against latest (32c2156)

  🔍 Preview build  

1 file changed
± index.html

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.

Error when building docs in parallel

1 participant