Skip to content

Honor path ordering in Flask quick references - #155

Closed
ANO3457 wants to merge 2 commits into
sphinx-contrib:mainfrom
ANO3457:fix/flaskqref-path-order-33
Closed

ANO3457 wants to merge 2 commits into
sphinx-contrib:mainfrom
ANO3457:fix/flaskqref-path-order-33

Conversation

@ANO3457

@ANO3457 ANO3457 commented Oct 23, 2026

Copy link
Copy Markdown

Fixes #33, following the maintainer's request for matching qrefflask/autoflask ordering and a reproducible test.

qrefflask currently collects rows into resource-name buckets and sorts the bucket names, overriding the endpoint path order produced by AutoflaskBase. Simply preserving bucket insertion order still fails when the same resource has paths on both sides of another resource.

This keeps the base directive's row order for :order: path and suppresses repeated resource labels/descriptions only within consecutive runs. Without :order: path, a stable resource-name sort preserves the historical alphabetical grouping and within-resource order. The documented option and a changelog entry are included.

The regression builds actual Sphinx HTML documentation from a Flask application whose registration, resource-name, and path orders differ. It compares quick-reference rows to the detailed API signatures, checks interleaved resources, repeated descriptions, unnamed resources, and unchanged default behavior. Before the fix: 2 failed, 2 passed. After the fix, the local full suite passes (15 passed, 1 Python-3.10-only wheel-smoke skip).

Validation of product head 14a8683e4b5e246afa9db4190b7374b621cc3b2e, based on 32c21562d85d3accf4f06a0a88a1b24f92089ce5:

  • Repository locked tox r -e py310: 16 passed, 0 skipped, including the wheel smoke test; documentation -W passed.
  • Repository locked tox r -e py313: 15 passed, 1 Python-3.10-only wheel smoke skip; documentation -W passed.
  • Linux validation run. The validation branch differs only by a fork-only workflow.
  • Final diff and target-main compatibility checked before submission.

This is separate from #154 (parallel-read metadata) and #153 (routing-table labels). No changes from those PRs are included.

AI disclosure: OpenAI Codex investigated, implemented, reviewed the diff, and executed the checks under the account owner's authorization. No personal human review is claimed.

@read-the-docs-community

read-the-docs-community Bot commented Oct 23, 2026 •

Copy link
Copy Markdown

Documentation build overview

📚 sphinxcontrib-httpdomain | 🛠️ Build #35385398 | 📁 Comparing c817323 against latest (32c2156)

  🔍 Preview build  

1 file changed
± index.html

@ANO3457
ANO3457 force-pushed the fix/flaskqref-path-order-33 branch from 14a8683 to 1a27459 Compare October 24, 2026 10:51
@stevepiercy

Copy link
Copy Markdown
Collaborator

@ANO3457 I won't review any PR that has malicious payloads in the commit history. Closing. You're welcome to open a clean PR.

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

2 participants