Skip to content

Fix upgrade guide sections showing as separate pages in the docs sidebar - #75468

Merged
kaxil merged 1 commit into
apache:mainfrom
astronomer:fix-upgrade-guide-heading-levels
Oct 23, 2026
Merged

kaxil merged 1 commit into
apache:mainfrom
astronomer:fix-upgrade-guide-heading-levels

Conversation

@kaxil

@kaxil kaxil commented Oct 23, 2026 •

Copy link
Copy Markdown
Member

In the Installation section of the docs sidebar, "Breaking Changes" and "Manual Dag Runs and logical_date" appear as separate pages next to "Upgrading to Airflow 3" instead of under it. Both are sections of upgrading_to_airflow3.rst, but they were underlined with =, the same character as the page title. RST read them as two more top-level titles, so the toctree listed the file three times.

This demotes both to -, the level used by "Step 1" through "Step 8". "Migration guidance" sits under "Manual Dag Runs" and moves from - to ^ to stay one level below it. The breaking-changes and data-interval-manual-triggering labels are unchanged, so existing :ref: links still resolve.

The two highlighted entries move from the Installation level (aligned with "Local start for development and testing") to inside "Upgrading to Airflow 3" (aligned with "Step 8").

Before (airflow.apache.org, stable) After (local breeze build-docs apache-airflow)
Before After

Breaking Changes and Manual Dag Runs used the page title's underline, so
Sphinx treated them as extra top-level titles and listed them as siblings
of the upgrade guide in the Installation navigation.
@kaxil
kaxil merged commit 09fafbc into apache:main Oct 23, 2026
25 checks passed
@kaxil
kaxil deleted the fix-upgrade-guide-heading-levels branch October 23, 2026 12:34
@kaxil kaxil added the backport-to-v3-4-test Backport to v3-4-test label Oct 23, 2026
kaxil added a commit that referenced this pull request Oct 23, 2026
…he docs sidebar (#75468) (#75470)

Breaking Changes and Manual Dag Runs used the page title's underline, so
Sphinx treated them as extra top-level titles and listed them as siblings
of the upgrade guide in the Installation navigation.
(cherry picked from commit 09fafbc)

Co-authored-by: Kaxil Naik <kaxilnaik@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants