Skip to content

Conversation

sunank200
Copy link
Collaborator

@sunank200 sunank200 commented Aug 13, 2025

Currently, all of the individual sections of the public airflow interface document appear in the sidebar nav, which is wrong.

This PR hide individual Public Interface subsections from sidebar navigation

  • Added :titlesonly: and :maxdepth: 1 to main toctree in index.rst to control sidebar depth
  • Added :hidden: to API documentation toctree directives to hide them from sidebar while preserving links

Before:
Screenshot 2025-08-13 at 5 33 22 PM

After:
Screenshot 2025-08-13 at 5 30 08 PM


^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in airflow-core/newsfragments.

@sunank200 sunank200 requested a review from ashb August 13, 2025 11:49
@sunank200 sunank200 force-pushed the fix-public-airflow-interface-docs branch from fcb5c61 to 3ee5448 Compare August 13, 2025 11:49
@sunank200 sunank200 added this to the Airflow 3.0.5 milestone Aug 13, 2025
Copy link
Member

@ashb ashb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This means it's not possible to link to the sections of the page. I wonder if there is something else we can do with Sphinx... 🤔

@sunank200 sunank200 force-pushed the fix-public-airflow-interface-docs branch from 59e6c25 to 7c2e80f Compare August 13, 2025 12:50
@sunank200
Copy link
Collaborator Author

This means it's not possible to link to the sections of the page. I wonder if there is something else we can do with Sphinx... 🤔

@ashb as you have suggested, I have done the change:

  • Added :titlesonly: and :maxdepth: 1 to main toctree in index.rst to control sidebar depth
  • Added :hidden: to API documentation toctree directives to hide them from sidebar while preserving links

@sunank200 sunank200 added the backport-to-v3-0-test Mark PR with this label to backport to v3-0-test branch label Aug 13, 2025
@sunank200 sunank200 self-assigned this Aug 13, 2025
@kaxil kaxil merged commit 0879af1 into apache:main Aug 13, 2025
58 checks passed
@kaxil kaxil deleted the fix-public-airflow-interface-docs branch August 13, 2025 13:27
github-actions bot pushed a commit that referenced this pull request Aug 13, 2025
… navigation (#54457)

* Hide individual Public Interface subsections from sidebar navigation

* Revert "Hide individual Public Interface subsections from sidebar navigation"

This reverts commit 3ee5448.

* Fix sidebar navigation to collapse Public Interface subsections by default
(cherry picked from commit 0879af1)

Co-authored-by: Ankit Chaurasia <[email protected]>
Copy link

Backport successfully created: v3-0-test

Status Branch Result
v3-0-test PR Link

github-actions bot pushed a commit to aws-mwaa/upstream-to-airflow that referenced this pull request Aug 13, 2025
… navigation (apache#54457)

* Hide individual Public Interface subsections from sidebar navigation

* Revert "Hide individual Public Interface subsections from sidebar navigation"

This reverts commit 3ee5448.

* Fix sidebar navigation to collapse Public Interface subsections by default
(cherry picked from commit 0879af1)

Co-authored-by: Ankit Chaurasia <[email protected]>
kaxil pushed a commit that referenced this pull request Aug 13, 2025
… navigation (#54457) (#54465)

* Hide individual Public Interface subsections from sidebar navigation

* Revert "Hide individual Public Interface subsections from sidebar navigation"

This reverts commit 3ee5448.

* Fix sidebar navigation to collapse Public Interface subsections by default
(cherry picked from commit 0879af1)

Co-authored-by: Ankit Chaurasia <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-to-v3-0-test Mark PR with this label to backport to v3-0-test branch kind:documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants