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-site.git
The following commit(s) were added to refs/heads/main by this push:
new c16a9ed389 Add doctoc prek hook for long MD files (#1354)
c16a9ed389 is described below
commit c16a9ed389e88c36debbed2c2dac6932f12eca00
Author: Shahar Epstein <[email protected]>
AuthorDate: Sat Dec 27 22:41:07 2025 +0200
Add doctoc prek hook for long MD files (#1354)
* Add doctoc prek hook for long MD files
* Update .pre-commit-config.yaml
Co-authored-by: Copilot <[email protected]>
---------
Co-authored-by: Copilot <[email protected]>
---
.pre-commit-config.yaml | 12 ++++++++++++
CONTRIBUTE.md | 18 ++++++++++++++++++
sphinx_airflow_theme/README.md | 17 +++++++++++++++++
3 files changed, 47 insertions(+)
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 5fa9cdbafb..ca8b84e085 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -163,3 +163,15 @@ repos:
- id: mixed-line-ending
- id: trailing-whitespace
args: [--markdown-linebreak-ext=md]
+ - repo: https://github.com/thlorenz/doctoc.git
+ rev: 68f070c98b9a053eabfa7f8899d1f42b9919f98c # frozen: v2.2.0
+ hooks:
+ - id: doctoc
+ name: Add TOC for Markdown files
+ files: >
+ (?x)
+ ^sphinx_airflow_theme/README\.md$|
+ ^CONTRIBUTE\.md$
+ args:
+ - "--maxlevel"
+ - "2"
diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
index 1580620f6c..3850fd39d2 100644
--- a/CONTRIBUTE.md
+++ b/CONTRIBUTE.md
@@ -1,3 +1,21 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update
-->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents** *generated with
[DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Contributor Guide](#contributor-guide)
+- [Working with the project](#working-with-the-project)
+- [How to release new documentation](#how-to-release-new-documentation)
+- [Publish site on Apache server (CI/CD)](#publish-site-on-apache-server-cicd)
+- [Publish site on Apache server (manual
way)](#publish-site-on-apache-server-manual-way)
+ - [Prerequisite tasks](#prerequisite-tasks)
+ - [Instruction](#instruction)
+- [Release and publish documentation in one
go](#release-and-publish-documentation-in-one-go)
+- [Additional tips:](#additional-tips)
+ - [Using VM on GCP](#using-vm-on-gcp)
+ - [Use RAM disk for build](#use-ram-disk-for-build)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
diff --git a/sphinx_airflow_theme/README.md b/sphinx_airflow_theme/README.md
index 0c37070941..859d65fd66 100644
--- a/sphinx_airflow_theme/README.md
+++ b/sphinx_airflow_theme/README.md
@@ -1,3 +1,20 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update
-->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents** *generated with
[DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Sphinx theme for Airflow](#sphinx-theme-for-airflow)
+- [Install from sources](#install-from-sources)
+- [Generate Airflow documentation with Sphinx theme
changes](#generate-airflow-documentation-with-sphinx-theme-changes)
+- [Install developer version](#install-developer-version)
+- [Configuration](#configuration)
+ - [`navbar_links`](#navbar_links)
+ - [`hide_website_buttons`](#hide_website_buttons)
+ - [`sidebar_collapse`](#sidebar_collapse)
+ - [`sidebar_includehidden`](#sidebar_includehidden)
+- [Theme's source files](#themes-source-files)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
