You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "sunank200 (via GitHub)" <gi...@apache.org> on 2025/08/13 11:49:28 UTC
[PR] Hide individual Public Interface subsections from sidebar navigation [airflow]
sunank200 opened a new pull request, #54457:
URL: https://github.com/apache/airflow/pull/54457
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
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
- Replace section headers with bold text to prevent automatic sidebar entries
- Change toctree directives from :includehidden: to :hidden: to hide API docs from sidebar
- Remove unnecessary explicit target labels
Before:
<img width="1350" height="1035" alt="Screenshot 2025-08-13 at 5 33 22 PM" src="https://github.com/user-attachments/assets/6714d23f-29b0-4665-a877-c6b00406fc13" />
After:
<img width="1007" height="1034" alt="Screenshot 2025-08-13 at 5 30 08 PM" src="https://github.com/user-attachments/assets/e77fac59-e0f1-4aaf-9f3d-fbe11732f7d8" />
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)** for more information.
In case of fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
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](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Hide individual Public Interface subsections from sidebar navigation [airflow]
Posted by "sunank200 (via GitHub)" <gi...@apache.org>.
sunank200 commented on PR #54457:
URL: https://github.com/apache/airflow/pull/54457#issuecomment-3183792424
> 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
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Hide individual Public Interface subsections from sidebar navigation [airflow]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #54457:
URL: https://github.com/apache/airflow/pull/54457#issuecomment-3183929245
### Backport successfully created: v3-0-test
<table>
<tr>
<th>Status</th>
<th>Branch</th>
<th>Result</th>
</tr>
<tr>
<td>✅</td>
<td>v3-0-test</td>
<td><a href="https://github.com/apache/airflow/pull/54465"><img src="https://img.shields.io/badge/PR-54465-blue" alt="PR Link"></a></td>
</tr>
</table>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Hide individual Public Interface subsections from sidebar navigation [airflow]
Posted by "kaxil (via GitHub)" <gi...@apache.org>.
kaxil merged PR #54457:
URL: https://github.com/apache/airflow/pull/54457
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org