Skip to content

Honor path ordering in Flask quick references - #157

Open
ANO3457 wants to merge 1 commit into
sphinx-contrib:mainfrom
ANO3457:fix/flaskqref-path-order-clean-33
Open

ANO3457 wants to merge 1 commit into
sphinx-contrib:mainfrom
ANO3457:fix/flaskqref-path-order-clean-33

Conversation

@ANO3457

@ANO3457 ANO3457 commented Oct 25, 2026

Copy link
Copy Markdown

Clean-history replacement for #155, following the maintainer's invitation. Fixes #33.

Flask quick references currently regroup rows alphabetically by resource name even when :order: path is requested. This preserves the base directive's path order and suppresses repeated resource labels/descriptions only within consecutive runs. Default ordering retains historical alphabetical grouping and stable within-resource order. Includes option documentation and a changelog entry.

The branch starts directly at current main 32c21562d85d3accf4f06a0a88a1b24f92089ce5, with exactly one feature commit 9bf9185692a14fb9e5590a9926504ef98876ecf3. Only flaskqref.py, its new regression test, docs/index.rst and CHANGELOG.rst differ. Former feature commits are not ancestors; .gitignore, editor/font/public assets and workflows have no diff.

The regression builds real Sphinx HTML from a Flask application whose registration, resource-name and path orders differ. It compares quick-reference rows with detailed API signatures and covers interleaved resources, repeated descriptions, unnamed resources and unchanged default behavior.

Exact-product Linux validation, repository 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 passed. All eight tox targets reported OK.
  • Local Windows Python 3.13/Sphinx 9.2: 15 passed, 1 wheel skip, docs -W passed.
  • The feature's complete Git tree is identical to the previously validated ordering implementation; the ancestry is rebuilt on main. The fork-only validation workflow is excluded.

This is separate from #156 (parallel-read metadata) and #153 (routing-table label registration).

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 sphinxcontrib-httpdomain | 🛠️ Build #35387132 | 📁 Comparing 9bf9185 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.

flaskqref :order: path violation

1 participant