This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 77e0e6a8ac9 Replace GitHub outline hints with RST table of contents
(#63311)
77e0e6a8ac9 is described below
commit 77e0e6a8ac9a9941cecff3f94fb993790d9430ba
Author: Jarek Potiuk <[email protected]>
AuthorDate: Wed Mar 11 00:30:18 2026 +0100
Replace GitHub outline hints with RST table of contents (#63311)
GitHub has restored native TOC rendering for RST files (via the
top-right outline button), making the manual "outline is available
at top-right corner" hints unnecessary. Replace them with a proper
`.. contents::` RST directive that provides a rendered TOC working
across all platforms (GitHub, local builds, readthedocs).
For very short files (CONTRIBUTING.rst) and mid-document occurrences,
the hint line is simply removed. Files that already have a TOC from
a previous PR also just have the hint removed.
Co-authored-by: Claude Opus 4.6 <[email protected]>
---
COMMITTERS.rst | 4 +++-
CONTRIBUTING.rst | 1 -
PROVIDERS.rst | 4 +++-
contributing-docs/01_roles_in_airflow_project.rst | 4 +++-
contributing-docs/02_how_to_communicate.rst | 4 +++-
contributing-docs/03_contributors_quick_start.rst | 4 +++-
contributing-docs/04_how_to_contribute.rst | 4 +++-
contributing-docs/05_pull_requests.rst | 4 +++-
contributing-docs/06_development_environments.rst | 4 +++-
contributing-docs/07_local_virtualenv.rst | 4 +++-
contributing-docs/08_static_code_checks.rst | 4 +++-
contributing-docs/10_working_with_git.rst | 4 +++-
contributing-docs/12_provider_distributions.rst | 4 +++-
contributing-docs/13_airflow_dependencies_and_extras.rst | 3 ---
contributing-docs/15_node_environment_setup.rst | 2 --
contributing-docs/16_adding_api_endpoints.rst | 4 +++-
contributing-docs/18_contribution_workflow.rst | 4 +++-
contributing-docs/23_provider_hook_migration_to_yaml.rst | 4 +++-
contributing-docs/quick-start-ide/contributors_quick_start_gitpod.rst | 4 +++-
.../quick-start-ide/contributors_quick_start_pycharm.rst | 4 +++-
contributing-docs/quick-start-ide/contributors_quick_start_vscode.rst | 4 +++-
contributing-docs/testing/docker_compose_tests.rst | 4 +++-
contributing-docs/testing/integration_tests.rst | 4 +++-
contributing-docs/testing/k8s_tests.rst | 4 +++-
contributing-docs/testing/system_tests.rst | 4 +++-
contributing-docs/testing/testing_packages.rst | 4 +++-
contributing-docs/testing/unit_tests.rst | 4 +++-
providers/ACCEPTING_PROVIDERS.rst | 2 --
providers/MANAGING_PROVIDERS_LIFECYCLE.rst | 2 --
providers/PROVIDER_GOVERNANCE.rst | 2 --
providers/PROVIDER_RELEASES.rst | 2 --
providers/SUSPENDING_AND_REMOVING_PROVIDERS.rst | 2 --
providers/THIRD_PARTY_PROVIDERS.rst | 2 --
33 files changed, 72 insertions(+), 42 deletions(-)
diff --git a/COMMITTERS.rst b/COMMITTERS.rst
index a4b247d8f35..23a52436918 100644
--- a/COMMITTERS.rst
+++ b/COMMITTERS.rst
@@ -22,7 +22,9 @@ Before reading this document, you should be familiar with the
`Contributors' gui
This document assumes that you are a bit familiar with how Airflow's community
works, but you would like to learn more
about the rules by which we add new committers and PMC members.
-**The outline for this document in GitHub is available at the top-right corner
button (with 3-dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
Committers vs. Maintainers
--------------------------
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index fc8180278f7..00fe429fad8 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -18,7 +18,6 @@
Contributing
============
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
Contributions are welcome and are greatly appreciated! Every little bit helps,
and credit will always be given.
diff --git a/PROVIDERS.rst b/PROVIDERS.rst
index 2caa00273ba..e5bd86e5a13 100644
--- a/PROVIDERS.rst
+++ b/PROVIDERS.rst
@@ -19,7 +19,9 @@
Apache Airflow Providers
************************
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
What is a provider?
===================
diff --git a/contributing-docs/01_roles_in_airflow_project.rst
b/contributing-docs/01_roles_in_airflow_project.rst
index 2f14904497a..70db9197965 100644
--- a/contributing-docs/01_roles_in_airflow_project.rst
+++ b/contributing-docs/01_roles_in_airflow_project.rst
@@ -22,7 +22,9 @@ There are several roles within the Airflow Open-Source
community.
For detailed information for each role, see: `Committers and PMC members
<../COMMITTERS.rst>`__.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
PMC Member
----------
diff --git a/contributing-docs/02_how_to_communicate.rst
b/contributing-docs/02_how_to_communicate.rst
index f01da6ca53d..04b3d47cd1e 100644
--- a/contributing-docs/02_how_to_communicate.rst
+++ b/contributing-docs/02_how_to_communicate.rst
@@ -26,7 +26,9 @@ This means that communication plays a big role in it, and
this chapter is all ab
In our communication, everyone is expected to follow the `ASF Code of Conduct
<https://www.apache.org/foundation/policies/conduct>`_.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
Various Communication channels
------------------------------
diff --git a/contributing-docs/03_contributors_quick_start.rst
b/contributing-docs/03_contributors_quick_start.rst
index 454a7b782db..1d4f64390f9 100644
--- a/contributing-docs/03_contributors_quick_start.rst
+++ b/contributing-docs/03_contributors_quick_start.rst
@@ -19,7 +19,9 @@
Contributor's Quick Start
*************************
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
Note to Starters
################
diff --git a/contributing-docs/04_how_to_contribute.rst
b/contributing-docs/04_how_to_contribute.rst
index e3bd22318a0..830ecfce418 100644
--- a/contributing-docs/04_how_to_contribute.rst
+++ b/contributing-docs/04_how_to_contribute.rst
@@ -21,7 +21,9 @@ How to contribute
There are various ways how you can contribute to Apache Airflow. Here is a
short overview of
some of those ways that involve creating issues and pull requests on GitHub.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
Report Bugs
-----------
diff --git a/contributing-docs/05_pull_requests.rst
b/contributing-docs/05_pull_requests.rst
index 639bb3659c9..ae8678710d9 100644
--- a/contributing-docs/05_pull_requests.rst
+++ b/contributing-docs/05_pull_requests.rst
@@ -22,7 +22,9 @@ Pull Requests
This document describes how you can create Pull Requests (PRs) and describes
coding standards we use when
implementing them.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
Protect your commit identity
----------------------------
diff --git a/contributing-docs/06_development_environments.rst
b/contributing-docs/06_development_environments.rst
index 67c7734a3d8..ea03ffa5b34 100644
--- a/contributing-docs/06_development_environments.rst
+++ b/contributing-docs/06_development_environments.rst
@@ -21,7 +21,9 @@ Development Environments
There are two environments, available on Linux and macOS, that you can use to
develop Apache Airflow.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
Local virtualenv Development Environment
----------------------------------------
diff --git a/contributing-docs/07_local_virtualenv.rst
b/contributing-docs/07_local_virtualenv.rst
index 82e823140a6..771d644775c 100644
--- a/contributing-docs/07_local_virtualenv.rst
+++ b/contributing-docs/07_local_virtualenv.rst
@@ -26,7 +26,9 @@ harder to debug the tests and to use your IDE to run them.
That's why we recommend using local virtualenv for development and testing.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
Required Software Packages
--------------------------
diff --git a/contributing-docs/08_static_code_checks.rst
b/contributing-docs/08_static_code_checks.rst
index 69e12196c50..2750cbafe5d 100644
--- a/contributing-docs/08_static_code_checks.rst
+++ b/contributing-docs/08_static_code_checks.rst
@@ -26,7 +26,9 @@ for the first time.
You can also run the checks via `Breeze <../dev/breeze/doc/README.rst>`_
environment.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
Prek hooks
----------
diff --git a/contributing-docs/10_working_with_git.rst
b/contributing-docs/10_working_with_git.rst
index 15372e2557f..5551b1ea513 100644
--- a/contributing-docs/10_working_with_git.rst
+++ b/contributing-docs/10_working_with_git.rst
@@ -22,7 +22,9 @@ Working with Git
In this document you can learn basics of how you should use Git in Airflow
project. It explains branching model and stresses
that we are using rebase workflow. It also explains how to sync your fork with
the main repository.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
Airflow Git Branches
====================
diff --git a/contributing-docs/12_provider_distributions.rst
b/contributing-docs/12_provider_distributions.rst
index cb2bb42e55c..523ad2a8fca 100644
--- a/contributing-docs/12_provider_distributions.rst
+++ b/contributing-docs/12_provider_distributions.rst
@@ -25,7 +25,9 @@ Airflow is split into core and providers. They are delivered
as separate distrib
* ``apache-airflow-task-sdk`` - task-sdk distribution that are imported by the
providers
* ``apache-airflow-providers-*`` - More than 90 providers to communicate with
external services
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
Where providers are kept in our repository
------------------------------------------
diff --git a/contributing-docs/13_airflow_dependencies_and_extras.rst
b/contributing-docs/13_airflow_dependencies_and_extras.rst
index 8e835cba818..cd43e486ffb 100644
--- a/contributing-docs/13_airflow_dependencies_and_extras.rst
+++ b/contributing-docs/13_airflow_dependencies_and_extras.rst
@@ -419,9 +419,6 @@ You can read more about those extras in the
`extras reference
<https://airflow.apache.org/docs/apache-airflow/stable/extra-packages-ref.html>`_.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
-
-
-----
You can now check how to update Airflow's `metadata database
<14_metadata_database_updates.rst>`__ if you need
diff --git a/contributing-docs/15_node_environment_setup.rst
b/contributing-docs/15_node_environment_setup.rst
index cdbb8840c8d..34285e9df7d 100644
--- a/contributing-docs/15_node_environment_setup.rst
+++ b/contributing-docs/15_node_environment_setup.rst
@@ -107,8 +107,6 @@ Project Structure
- ``/src/theme.ts`` the theme for the UI, update this to change the colors,
fonts, etc.
- ``/src/queryClient.ts`` the query client for the UI, update this to change
the default options for the API requests
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
-
React, JSX and Chakra
---------------------
diff --git a/contributing-docs/16_adding_api_endpoints.rst
b/contributing-docs/16_adding_api_endpoints.rst
index 85ccf1f94e7..b4485024a5e 100644
--- a/contributing-docs/16_adding_api_endpoints.rst
+++ b/contributing-docs/16_adding_api_endpoints.rst
@@ -20,7 +20,9 @@ Adding a New API Endpoint in Apache Airflow
This documentation outlines the steps required to add a new API endpoint in
Apache Airflow. It includes implementing the logic, running prek hooks, and
documenting the changes.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
Introduction
diff --git a/contributing-docs/18_contribution_workflow.rst
b/contributing-docs/18_contribution_workflow.rst
index 8cbc37c98cd..4dec1a0740e 100644
--- a/contributing-docs/18_contribution_workflow.rst
+++ b/contributing-docs/18_contribution_workflow.rst
@@ -18,7 +18,9 @@
Contribution Workflow
=====================
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
Typically, you start your first contribution by reviewing open tickets
at `GitHub issues <https://github.com/apache/airflow/issues>`__.
diff --git a/contributing-docs/23_provider_hook_migration_to_yaml.rst
b/contributing-docs/23_provider_hook_migration_to_yaml.rst
index ce9a3fd8dd5..f751f9675a9 100644
--- a/contributing-docs/23_provider_hook_migration_to_yaml.rst
+++ b/contributing-docs/23_provider_hook_migration_to_yaml.rst
@@ -21,7 +21,9 @@ Provider hook to YAML Migration
We can now, redefine connection form metadata declaratively in
``provider.yaml`` of a provider instead of Python hook code,
reducing dependencies and improving API server startup performance.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
Background
----------
diff --git
a/contributing-docs/quick-start-ide/contributors_quick_start_gitpod.rst
b/contributing-docs/quick-start-ide/contributors_quick_start_gitpod.rst
index 580844fb17f..08ae88c1f5c 100644
--- a/contributing-docs/quick-start-ide/contributors_quick_start_gitpod.rst
+++ b/contributing-docs/quick-start-ide/contributors_quick_start_gitpod.rst
@@ -15,7 +15,9 @@
specific language governing permissions and limitations
under the License.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
Connect your project to Gitpod
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git
a/contributing-docs/quick-start-ide/contributors_quick_start_pycharm.rst
b/contributing-docs/quick-start-ide/contributors_quick_start_pycharm.rst
index cdb691a7e5b..09e7599f7de 100644
--- a/contributing-docs/quick-start-ide/contributors_quick_start_pycharm.rst
+++ b/contributing-docs/quick-start-ide/contributors_quick_start_pycharm.rst
@@ -15,7 +15,9 @@
specific language governing permissions and limitations
under the License.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
Setup your project
##################
diff --git
a/contributing-docs/quick-start-ide/contributors_quick_start_vscode.rst
b/contributing-docs/quick-start-ide/contributors_quick_start_vscode.rst
index 3291b3c93d7..414acaeea4e 100644
--- a/contributing-docs/quick-start-ide/contributors_quick_start_vscode.rst
+++ b/contributing-docs/quick-start-ide/contributors_quick_start_vscode.rst
@@ -15,7 +15,9 @@
specific language governing permissions and limitations
under the License.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
Setup your project
##################
diff --git a/contributing-docs/testing/docker_compose_tests.rst
b/contributing-docs/testing/docker_compose_tests.rst
index 68ee83895e6..8c8dcb8306c 100644
--- a/contributing-docs/testing/docker_compose_tests.rst
+++ b/contributing-docs/testing/docker_compose_tests.rst
@@ -20,7 +20,9 @@ Airflow Docker Compose Tests
This document describes how to run tests for Airflow Docker Compose deployment.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
Running Docker Compose Tests with Breeze
----------------------------------------
diff --git a/contributing-docs/testing/integration_tests.rst
b/contributing-docs/testing/integration_tests.rst
index 1158c59bc97..cc4c41eb007 100644
--- a/contributing-docs/testing/integration_tests.rst
+++ b/contributing-docs/testing/integration_tests.rst
@@ -24,7 +24,9 @@ These tests require ``airflow`` Docker image and extra images
with integrations
The integration tests are all stored in the ``tests/integration`` folder, and
similarly to the unit tests they all run
using `pytest <http://doc.pytest.org/en/latest/>`_, but they are skipped by
default unless ``--integration`` flag is passed to pytest.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
Enabling Integrations
---------------------
diff --git a/contributing-docs/testing/k8s_tests.rst
b/contributing-docs/testing/k8s_tests.rst
index bfb823cf828..084bb5e0923 100644
--- a/contributing-docs/testing/k8s_tests.rst
+++ b/contributing-docs/testing/k8s_tests.rst
@@ -25,7 +25,9 @@ deploy and run the cluster tests in our repository and into
Breeze development e
KinD has a really nice ``kind`` tool that you can use to interact with the
cluster. Run ``kind --help`` to
learn more.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
K8S test environment
--------------------
diff --git a/contributing-docs/testing/system_tests.rst
b/contributing-docs/testing/system_tests.rst
index ffe0b4c7c90..19341c7ba5e 100644
--- a/contributing-docs/testing/system_tests.rst
+++ b/contributing-docs/testing/system_tests.rst
@@ -25,7 +25,9 @@ external services. A system test tries to look as close to a
regular Dag as poss
System tests need to communicate with external services/systems that are
available
if you have appropriate credentials configured for your tests.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
Purpose of System Tests
-----------------------
diff --git a/contributing-docs/testing/testing_packages.rst
b/contributing-docs/testing/testing_packages.rst
index c9024b07896..324eebca9b4 100644
--- a/contributing-docs/testing/testing_packages.rst
+++ b/contributing-docs/testing/testing_packages.rst
@@ -22,7 +22,9 @@ Breeze can be used to test new release candidates of
distributions - both Airflo
configure the CI image of Breeze to install and start Airflow for both Airflow
and providers, whether they
are built from sources or downloaded from PyPI as release candidates.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
Prerequisites
-------------
diff --git a/contributing-docs/testing/unit_tests.rst
b/contributing-docs/testing/unit_tests.rst
index f8c08f9c176..272824cec52 100644
--- a/contributing-docs/testing/unit_tests.rst
+++ b/contributing-docs/testing/unit_tests.rst
@@ -20,7 +20,9 @@ Airflow Unit Tests
All unit tests for Apache Airflow are run using `pytest
<http://doc.pytest.org/en/latest/>`_.
-**The outline for this document in GitHub is available via the button in the
top-right corner (icon with 3 dots and 3 lines).**
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
Writing Unit Tests
------------------
diff --git a/providers/ACCEPTING_PROVIDERS.rst
b/providers/ACCEPTING_PROVIDERS.rst
index ca69f1ea11f..a17dc397f4f 100644
--- a/providers/ACCEPTING_PROVIDERS.rst
+++ b/providers/ACCEPTING_PROVIDERS.rst
@@ -15,8 +15,6 @@
specific language governing permissions and limitations
under the License.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
-
Accepting New Community Providers
==================================
diff --git a/providers/MANAGING_PROVIDERS_LIFECYCLE.rst
b/providers/MANAGING_PROVIDERS_LIFECYCLE.rst
index 2dcb5a70c89..b3d2076c004 100644
--- a/providers/MANAGING_PROVIDERS_LIFECYCLE.rst
+++ b/providers/MANAGING_PROVIDERS_LIFECYCLE.rst
@@ -15,8 +15,6 @@
specific language governing permissions and limitations
under the License.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
-
Managing Provider's Lifecycle
==============================
diff --git a/providers/PROVIDER_GOVERNANCE.rst
b/providers/PROVIDER_GOVERNANCE.rst
index b9852968b4e..0fe29b0c57b 100644
--- a/providers/PROVIDER_GOVERNANCE.rst
+++ b/providers/PROVIDER_GOVERNANCE.rst
@@ -15,8 +15,6 @@
specific language governing permissions and limitations
under the License.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
-
Provider Governance
====================
diff --git a/providers/PROVIDER_RELEASES.rst b/providers/PROVIDER_RELEASES.rst
index f54da65d3e4..26f50b9e42c 100644
--- a/providers/PROVIDER_RELEASES.rst
+++ b/providers/PROVIDER_RELEASES.rst
@@ -15,8 +15,6 @@
specific language governing permissions and limitations
under the License.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
-
Provider Releases and Versioning
=================================
diff --git a/providers/SUSPENDING_AND_REMOVING_PROVIDERS.rst
b/providers/SUSPENDING_AND_REMOVING_PROVIDERS.rst
index 31c3d88a771..9a54b9eec79 100644
--- a/providers/SUSPENDING_AND_REMOVING_PROVIDERS.rst
+++ b/providers/SUSPENDING_AND_REMOVING_PROVIDERS.rst
@@ -15,8 +15,6 @@
specific language governing permissions and limitations
under the License.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
-
Suspending and Removing Providers
==================================
diff --git a/providers/THIRD_PARTY_PROVIDERS.rst
b/providers/THIRD_PARTY_PROVIDERS.rst
index 3394fd6bff0..dc3953a6474 100644
--- a/providers/THIRD_PARTY_PROVIDERS.rst
+++ b/providers/THIRD_PARTY_PROVIDERS.rst
@@ -15,8 +15,6 @@
specific language governing permissions and limitations
under the License.
-**The outline for this document in GitHub is available at top-right corner
button (with 3-dots and 3 lines).**
-
3rd-Party Providers
====================
