-
Notifications
You must be signed in to change notification settings - Fork 15.6k
Hide individual Public Interface subsections from sidebar navigation #54457
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Hide individual Public Interface subsections from sidebar navigation #54457
Conversation
fcb5c61
to
3ee5448
Compare
There was a problem hiding this 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... 🤔
59e6c25
to
7c2e80f
Compare
@ashb as you have suggested, I have done the change:
|
… 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]>
… 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]>
… 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]>
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
:titlesonly:
and:maxdepth: 1
to main toctree inindex.rst
to control sidebar depth:hidden:
to API documentation toctree directives to hide them from sidebar while preserving linksBefore:

After:

^ 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.