🔨 Add MkDocs hook that renames sections based on the first index file (…

…fastapi#9737)
shekarsiri · Jun 24, 2023 · 51d3a8f · 51d3a8f
1 parent 3aea9ac
commit 51d3a8f
Show file tree

Hide file tree

Showing 58 changed files with 145 additions and 32 deletions.
diff --git a/docs/az/mkdocs.yml b/docs/az/mkdocs.yml
@@ -23,6 +23,7 @@ theme:
   - search.suggest
   - search.highlight
   - content.tabs.link
+  - navigation.indexes
   icon:
     repo: fontawesome/brands/github-alt
   logo: https://fastapi.tiangolo.com/img/icon-white.svg
@@ -158,3 +159,5 @@ extra_css:
 extra_javascript:
 - https://fastapi.tiangolo.com/js/termynal.js
 - https://fastapi.tiangolo.com/js/custom.js
+hooks:
+- ../../scripts/mkdocs_hooks.py
diff --git a/docs/cs/mkdocs.yml b/docs/cs/mkdocs.yml
@@ -23,6 +23,7 @@ theme:
   - search.suggest
   - search.highlight
   - content.tabs.link
+  - navigation.indexes
   icon:
     repo: fontawesome/brands/github-alt
   logo: https://fastapi.tiangolo.com/img/icon-white.svg
@@ -158,3 +159,5 @@ extra_css:
 extra_javascript:
 - https://fastapi.tiangolo.com/js/termynal.js
 - https://fastapi.tiangolo.com/js/custom.js
+hooks:
+- ../../scripts/mkdocs_hooks.py
diff --git a/docs/de/mkdocs.yml b/docs/de/mkdocs.yml
@@ -23,6 +23,7 @@ theme:
   - search.suggest
   - search.highlight
   - content.tabs.link
+  - navigation.indexes
   icon:
     repo: fontawesome/brands/github-alt
   logo: https://fastapi.tiangolo.com/img/icon-white.svg
@@ -159,3 +160,5 @@ extra_css:
 extra_javascript:
 - https://fastapi.tiangolo.com/js/termynal.js
 - https://fastapi.tiangolo.com/js/custom.js
+hooks:
+- ../../scripts/mkdocs_hooks.py
diff --git a/docs/em/docs/advanced/index.md b/docs/em/docs/advanced/index.md
@@ -1,4 +1,4 @@
-# 🏧 👩‍💻 🦮 - 🎶
+# 🏧 👩‍💻 🦮
 
 ## 🌖 ⚒
 

diff --git a/docs/em/docs/advanced/security/index.md b/docs/em/docs/advanced/security/index.md
@@ -1,4 +1,4 @@
-# 🏧 💂‍♂ - 🎶
+# 🏧 💂‍♂
 
 ## 🌖 ⚒
 

diff --git a/docs/em/docs/deployment/index.md b/docs/em/docs/deployment/index.md
@@ -1,4 +1,4 @@
-# 🛠️ - 🎶
+# 🛠️
 
 🛠️ **FastAPI** 🈸 📶 ⏩.
 

diff --git a/docs/em/docs/tutorial/dependencies/index.md b/docs/em/docs/tutorial/dependencies/index.md
@@ -1,4 +1,4 @@
-# 🔗 - 🥇 🔁
+# 🔗
 
 **FastAPI** ✔️ 📶 🏋️ ✋️ 🏋️ **<abbr title="also known as components, resources, providers, services, injectables">🔗 💉</abbr>** ⚙️.
 

diff --git a/docs/em/docs/tutorial/index.md b/docs/em/docs/tutorial/index.md
@@ -1,4 +1,4 @@
-# 🔰 - 👩‍💻 🦮 - 🎶
+# 🔰 - 👩‍💻 🦮
 
 👉 🔰 🎦 👆 ❔ ⚙️ **FastAPI** ⏮️ 🌅 🚮 ⚒, 🔁 🔁.
 

diff --git a/docs/em/docs/tutorial/security/index.md b/docs/em/docs/tutorial/security/index.md
@@ -1,4 +1,4 @@
-# 💂‍♂ 🎶
+# 💂‍♂
 
 📤 📚 🌌 🍵 💂‍♂, 🤝 &amp; ✔.
 

diff --git a/docs/em/mkdocs.yml b/docs/em/mkdocs.yml
@@ -23,6 +23,7 @@ theme:
   - search.suggest
   - search.highlight
   - content.tabs.link
+  - navigation.indexes
   icon:
     repo: fontawesome/brands/github-alt
   logo: https://fastapi.tiangolo.com/img/icon-white.svg
@@ -265,3 +266,5 @@ extra_css:
 extra_javascript:
 - https://fastapi.tiangolo.com/js/termynal.js
 - https://fastapi.tiangolo.com/js/custom.js
+hooks:
+- ../../scripts/mkdocs_hooks.py
diff --git a/docs/en/docs/advanced/index.md b/docs/en/docs/advanced/index.md
@@ -1,4 +1,4 @@
-# Advanced User Guide - Intro
+# Advanced User Guide
 
 ## Additional Features
 

diff --git a/docs/en/docs/advanced/security/index.md b/docs/en/docs/advanced/security/index.md
@@ -1,4 +1,4 @@
-# Advanced Security - Intro
+# Advanced Security
 
 ## Additional Features
 

diff --git a/docs/en/docs/deployment/index.md b/docs/en/docs/deployment/index.md
@@ -1,4 +1,4 @@
-# Deployment - Intro
+# Deployment
 
 Deploying a **FastAPI** application is relatively easy.
 

diff --git a/docs/en/docs/tutorial/dependencies/index.md b/docs/en/docs/tutorial/dependencies/index.md
@@ -1,4 +1,4 @@
-# Dependencies - First Steps
+# Dependencies
 
 **FastAPI** has a very powerful but intuitive **<abbr title="also known as components, resources, providers, services, injectables">Dependency Injection</abbr>** system.
 

diff --git a/docs/en/docs/tutorial/index.md b/docs/en/docs/tutorial/index.md
@@ -1,4 +1,4 @@
-# Tutorial - User Guide - Intro
+# Tutorial - User Guide
 
 This tutorial shows you how to use **FastAPI** with most of its features, step by step.
 

diff --git a/docs/en/docs/tutorial/security/index.md b/docs/en/docs/tutorial/security/index.md
@@ -1,4 +1,4 @@
-# Security Intro
+# Security
 
 There are many ways to handle security, authentication and authorization.
 

diff --git a/docs/en/mkdocs.yml b/docs/en/mkdocs.yml
@@ -23,6 +23,7 @@ theme:
   - search.suggest
   - search.highlight
   - content.tabs.link
+  - navigation.indexes
   icon:
     repo: fontawesome/brands/github-alt
   logo: img/icon-white.svg
@@ -265,3 +266,5 @@ extra_css:
 extra_javascript:
 - js/termynal.js
 - js/custom.js
+hooks:
+- ../../scripts/mkdocs_hooks.py
diff --git a/docs/es/docs/advanced/index.md b/docs/es/docs/advanced/index.md
@@ -1,4 +1,4 @@
-# Guía de Usuario Avanzada - Introducción
+# Guía de Usuario Avanzada
 
 ## Características Adicionales
 

diff --git a/docs/es/docs/tutorial/index.md b/docs/es/docs/tutorial/index.md
@@ -1,4 +1,4 @@
-# Tutorial - Guía de Usuario - Introducción
+# Tutorial - Guía de Usuario
 
 Este tutorial te muestra cómo usar **FastAPI** con la mayoría de sus características paso a paso.
 

diff --git a/docs/es/mkdocs.yml b/docs/es/mkdocs.yml
@@ -23,6 +23,7 @@ theme:
   - search.suggest
   - search.highlight
   - content.tabs.link
+  - navigation.indexes
   icon:
     repo: fontawesome/brands/github-alt
   logo: https://fastapi.tiangolo.com/img/icon-white.svg
@@ -168,3 +169,5 @@ extra_css:
 extra_javascript:
 - https://fastapi.tiangolo.com/js/termynal.js
 - https://fastapi.tiangolo.com/js/custom.js
+hooks:
+- ../../scripts/mkdocs_hooks.py
diff --git a/docs/fa/mkdocs.yml b/docs/fa/mkdocs.yml
@@ -23,6 +23,7 @@ theme:
   - search.suggest
   - search.highlight
   - content.tabs.link
+  - navigation.indexes
   icon:
     repo: fontawesome/brands/github-alt
   logo: https://fastapi.tiangolo.com/img/icon-white.svg
@@ -158,3 +159,5 @@ extra_css:
 extra_javascript:
 - https://fastapi.tiangolo.com/js/termynal.js
 - https://fastapi.tiangolo.com/js/custom.js
+hooks:
+- ../../scripts/mkdocs_hooks.py
diff --git a/docs/fr/docs/advanced/index.md b/docs/fr/docs/advanced/index.md
@@ -1,4 +1,4 @@
-# Guide de l'utilisateur avancé - Introduction
+# Guide de l'utilisateur avancé
 
 ## Caractéristiques supplémentaires
 

diff --git a/docs/fr/docs/deployment/index.md b/docs/fr/docs/deployment/index.md
@@ -1,4 +1,4 @@
-# Déploiement - Intro
+# Déploiement
 
 Le déploiement d'une application **FastAPI** est relativement simple.
 

diff --git a/docs/fr/mkdocs.yml b/docs/fr/mkdocs.yml
@@ -23,6 +23,7 @@ theme:
   - search.suggest
   - search.highlight
   - content.tabs.link
+  - navigation.indexes
   icon:
     repo: fontawesome/brands/github-alt
   logo: https://fastapi.tiangolo.com/img/icon-white.svg
@@ -187,3 +188,5 @@ extra_css:
 extra_javascript:
 - https://fastapi.tiangolo.com/js/termynal.js
 - https://fastapi.tiangolo.com/js/custom.js
+hooks:
+- ../../scripts/mkdocs_hooks.py
diff --git a/docs/he/mkdocs.yml b/docs/he/mkdocs.yml
@@ -23,6 +23,7 @@ theme:
   - search.suggest
   - search.highlight
   - content.tabs.link
+  - navigation.indexes
   icon:
     repo: fontawesome/brands/github-alt
   logo: https://fastapi.tiangolo.com/img/icon-white.svg
@@ -158,3 +159,5 @@ extra_css:
 extra_javascript:
 - https://fastapi.tiangolo.com/js/termynal.js
 - https://fastapi.tiangolo.com/js/custom.js
+hooks:
+- ../../scripts/mkdocs_hooks.py
diff --git a/docs/hy/mkdocs.yml b/docs/hy/mkdocs.yml
@@ -23,6 +23,7 @@ theme:
   - search.suggest
   - search.highlight
   - content.tabs.link
+  - navigation.indexes
   icon:
     repo: fontawesome/brands/github-alt
   logo: https://fastapi.tiangolo.com/img/icon-white.svg
@@ -158,3 +159,5 @@ extra_css:
 extra_javascript:
 - https://fastapi.tiangolo.com/js/termynal.js
 - https://fastapi.tiangolo.com/js/custom.js
+hooks:
+- ../../scripts/mkdocs_hooks.py
diff --git a/docs/id/mkdocs.yml b/docs/id/mkdocs.yml
@@ -23,6 +23,7 @@ theme:
   - search.suggest
   - search.highlight
   - content.tabs.link
+  - navigation.indexes
   icon:
     repo: fontawesome/brands/github-alt
   logo: https://fastapi.tiangolo.com/img/icon-white.svg
@@ -158,3 +159,5 @@ extra_css:
 extra_javascript:
 - https://fastapi.tiangolo.com/js/termynal.js
 - https://fastapi.tiangolo.com/js/custom.js
+hooks:
+- ../../scripts/mkdocs_hooks.py
diff --git a/docs/it/mkdocs.yml b/docs/it/mkdocs.yml
@@ -23,6 +23,7 @@ theme:
   - search.suggest
   - search.highlight
   - content.tabs.link
+  - navigation.indexes
   icon:
     repo: fontawesome/brands/github-alt
   logo: https://fastapi.tiangolo.com/img/icon-white.svg
@@ -158,3 +159,5 @@ extra_css:
 extra_javascript:
 - https://fastapi.tiangolo.com/js/termynal.js
 - https://fastapi.tiangolo.com/js/custom.js
+hooks:
+- ../../scripts/mkdocs_hooks.py
diff --git a/docs/ja/docs/advanced/index.md b/docs/ja/docs/advanced/index.md
@@ -1,4 +1,4 @@
-# ユーザーガイド 応用編
+# 高度なユーザーガイド
 
 ## さらなる機能
 

diff --git a/docs/ja/docs/deployment/index.md b/docs/ja/docs/deployment/index.md
@@ -1,4 +1,4 @@
-# デプロイ - イントロ
+# デプロイ
 
 **FastAPI** 製のアプリケーションは比較的容易にデプロイできます。
 

diff --git a/docs/ja/docs/tutorial/index.md b/docs/ja/docs/tutorial/index.md
@@ -1,4 +1,4 @@
-# チュートリアル - ユーザーガイド - はじめに
+# チュートリアル - ユーザーガイド
 
 このチュートリアルは**FastAPI**のほぼすべての機能の使い方を段階的に紹介します。
 

diff --git a/docs/ja/mkdocs.yml b/docs/ja/mkdocs.yml
@@ -23,6 +23,7 @@ theme:
   - search.suggest
   - search.highlight
   - content.tabs.link
+  - navigation.indexes
   icon:
     repo: fontawesome/brands/github-alt
   logo: https://fastapi.tiangolo.com/img/icon-white.svg
@@ -202,3 +203,5 @@ extra_css:
 extra_javascript:
 - https://fastapi.tiangolo.com/js/termynal.js
 - https://fastapi.tiangolo.com/js/custom.js
+hooks:
+- ../../scripts/mkdocs_hooks.py
diff --git a/docs/ko/docs/tutorial/index.md b/docs/ko/docs/tutorial/index.md
@@ -1,4 +1,4 @@
-# 자습서 - 사용자 안내서 - 도입부
+# 자습서 - 사용자 안내서
 
 이 자습서는 **FastAPI**의 대부분의 기능을 단계별로 사용하는 방법을 보여줍니다.
 

diff --git a/docs/ko/mkdocs.yml b/docs/ko/mkdocs.yml
@@ -23,6 +23,7 @@ theme:
   - search.suggest
   - search.highlight
   - content.tabs.link
+  - navigation.indexes
   icon:
     repo: fontawesome/brands/github-alt
   logo: https://fastapi.tiangolo.com/img/icon-white.svg
@@ -172,3 +173,5 @@ extra_css:
 extra_javascript:
 - https://fastapi.tiangolo.com/js/termynal.js
 - https://fastapi.tiangolo.com/js/custom.js
+hooks:
+- ../../scripts/mkdocs_hooks.py
diff --git a/docs/lo/mkdocs.yml b/docs/lo/mkdocs.yml
@@ -23,6 +23,7 @@ theme:
   - search.suggest
   - search.highlight
   - content.tabs.link
+  - navigation.indexes
   icon:
     repo: fontawesome/brands/github-alt
   logo: https://fastapi.tiangolo.com/img/icon-white.svg
@@ -158,3 +159,5 @@ extra_css:
 extra_javascript:
 - https://fastapi.tiangolo.com/js/termynal.js
 - https://fastapi.tiangolo.com/js/custom.js
+hooks:
+- ../../scripts/mkdocs_hooks.py
diff --git a/docs/nl/mkdocs.yml b/docs/nl/mkdocs.yml
@@ -23,6 +23,7 @@ theme:
   - search.suggest
   - search.highlight
   - content.tabs.link
+  - navigation.indexes
   icon:
     repo: fontawesome/brands/github-alt
   logo: https://fastapi.tiangolo.com/img/icon-white.svg
@@ -158,3 +159,5 @@ extra_css:
 extra_javascript:
 - https://fastapi.tiangolo.com/js/termynal.js
 - https://fastapi.tiangolo.com/js/custom.js
+hooks:
+- ../../scripts/mkdocs_hooks.py
diff --git a/docs/pl/docs/tutorial/index.md b/docs/pl/docs/tutorial/index.md
@@ -1,4 +1,4 @@
-# Samouczek - Wprowadzenie
+# Samouczek
 
 Ten samouczek pokaże Ci, krok po kroku, jak używać większości funkcji **FastAPI**.
 

diff --git a/docs/pl/mkdocs.yml b/docs/pl/mkdocs.yml
@@ -23,6 +23,7 @@ theme:
   - search.suggest
   - search.highlight
   - content.tabs.link
+  - navigation.indexes
   icon:
     repo: fontawesome/brands/github-alt
   logo: https://fastapi.tiangolo.com/img/icon-white.svg
@@ -162,3 +163,5 @@ extra_css:
 extra_javascript:
 - https://fastapi.tiangolo.com/js/termynal.js
 - https://fastapi.tiangolo.com/js/custom.js
+hooks:
+- ../../scripts/mkdocs_hooks.py
diff --git a/docs/pt/docs/advanced/index.md b/docs/pt/docs/advanced/index.md
@@ -1,4 +1,4 @@
-# Guia de Usuário Avançado - Introdução
+# Guia de Usuário Avançado
 
 ## Recursos Adicionais
 

diff --git a/docs/pt/docs/deployment/index.md b/docs/pt/docs/deployment/index.md
@@ -1,4 +1,4 @@
-# Implantação - Introdução
+# Implantação
 
 A implantação de uma aplicação **FastAPI** é relativamente simples.
 

diff --git a/docs/pt/docs/tutorial/index.md b/docs/pt/docs/tutorial/index.md
@@ -1,4 +1,4 @@
-# Tutorial - Guia de Usuário - Introdução
+# Tutorial - Guia de Usuário
 
 Esse tutorial mostra como usar o **FastAPI** com a maior parte de seus recursos, passo a passo.
 

diff --git a/docs/pt/docs/tutorial/security/index.md b/docs/pt/docs/tutorial/security/index.md
@@ -1,4 +1,4 @@
-# Introdução à segurança
+# Segurança
 
 Há várias formas de lidar segurança, autenticação e autorização.