]> git.ipfire.org Git - thirdparty/fastapi/fastapi.git/commit
✨ Refactor docs for building scripts, use MkDocs hooks, simplify (remove) configs...
authorSebastián Ramírez <tiangolo@gmail.com>
Sun, 25 Jun 2023 12:33:58 +0000 (14:33 +0200)
committerGitHub <noreply@github.com>
Sun, 25 Jun 2023 12:33:58 +0000 (14:33 +0200)
commit5656ed09efea3451145087f63e402a0d024622b5
treeb60cb1e95a98150466b78ddd8d24fa8d168aabcc
parentc563b5bcf11a35f36a5f9345facf52b39ca7e9dd
✨ Refactor docs for building scripts, use MkDocs hooks, simplify (remove) configs for languages (#9742)

* ✨ Add MkDocs hooks to re-use all config from en, and auto-generate missing docs files form en

* 🔧 Update MkDocs config for es

* 🔧 Simplify configs for all languages

* ✨ Compute available languages from MkDocs Material for config overrides in hooks

* 🔧 Update config for MkDocs for en, to make paths compatible for other languages

* ♻️ Refactor scripts/docs.py to remove all custom logic that is now handled by the MkDocs hooks

* 🔧 Remove ta language as it's incomplete (no translations and causing errors)

* 🔥 Remove ta lang, no translations available

* 🔥 Remove dummy overrides directories, no longer needed

* ✨ Use the same missing-translation.md file contents for hooks

* ⏪️ Restore and refactor new-lang command

* 📝 Update docs for contributing with new simplified workflow for translations

* 🔊 Enable logs so that MkDocs can show its standard output on the docs.py script
52 files changed:
docs/az/mkdocs.yml
docs/az/overrides/.gitignore [deleted file]
docs/cs/mkdocs.yml
docs/cs/overrides/.gitignore [deleted file]
docs/de/mkdocs.yml
docs/de/overrides/.gitignore [deleted file]
docs/em/mkdocs.yml
docs/em/overrides/.gitignore [deleted file]
docs/en/docs/contributing.md
docs/en/mkdocs.yml
docs/es/mkdocs.yml
docs/es/overrides/.gitignore [deleted file]
docs/fa/mkdocs.yml
docs/fa/overrides/.gitignore [deleted file]
docs/fr/mkdocs.yml
docs/fr/overrides/.gitignore [deleted file]
docs/he/mkdocs.yml
docs/he/overrides/.gitignore [deleted file]
docs/hy/mkdocs.yml
docs/hy/overrides/.gitignore [deleted file]
docs/id/mkdocs.yml
docs/id/overrides/.gitignore [deleted file]
docs/it/mkdocs.yml
docs/it/overrides/.gitignore [deleted file]
docs/ja/mkdocs.yml
docs/ja/overrides/.gitignore [deleted file]
docs/ko/mkdocs.yml
docs/ko/overrides/.gitignore [deleted file]
docs/lo/mkdocs.yml
docs/lo/overrides/.gitignore [deleted file]
docs/nl/mkdocs.yml
docs/nl/overrides/.gitignore [deleted file]
docs/pl/mkdocs.yml
docs/pl/overrides/.gitignore [deleted file]
docs/pt/mkdocs.yml
docs/pt/overrides/.gitignore [deleted file]
docs/ru/mkdocs.yml
docs/ru/overrides/.gitignore [deleted file]
docs/sq/mkdocs.yml
docs/sq/overrides/.gitignore [deleted file]
docs/sv/mkdocs.yml
docs/sv/overrides/.gitignore [deleted file]
docs/ta/mkdocs.yml [deleted file]
docs/ta/overrides/.gitignore [deleted file]
docs/tr/mkdocs.yml
docs/tr/overrides/.gitignore [deleted file]
docs/uk/mkdocs.yml
docs/uk/overrides/.gitignore [deleted file]
docs/zh/mkdocs.yml
docs/zh/overrides/.gitignore [deleted file]
scripts/docs.py
scripts/mkdocs_hooks.py