Add doctoc prek hook for long MD files

Author: shahar1

.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 and RST files
+        files: |
+          (?x)
+          ^sphinx_airflow_theme/README\.md$|
+          ^CONTRIBUTE\.md$
+        args:
+          - "--maxlevel"
+          - "2"

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

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