]> git.ipfire.org Git - thirdparty/fastapi/fastapi.git/commit
📝 Add new docs section, How To - Recipes, move docs that don't have to be read by...
authorSebastián Ramírez <tiangolo@gmail.com>
Sat, 19 Aug 2023 19:54:04 +0000 (21:54 +0200)
committerGitHub <noreply@github.com>
Sat, 19 Aug 2023 19:54:04 +0000 (21:54 +0200)
commit8cd7cfc2b622fad03455c324e2ae87014a3fd166
tree756438eb2ba74b2b819565ccef79e8fb499a7d84
parent3971c44a38fa703f56eb1801765d3f076a5c1b2c
📝 Add new docs section, How To - Recipes, move docs that don't have to be read by everyone to How To (#10114)

* 📝 Start How To docs section, move Peewee, remove Peewee from dependencies

* 🚚 Move em files to new locations

* 🚚 Move and re-structure advanced docs, move relevant to How To

* 🔧 Update MkDocs config, new files in How To

* 📝 Move docs for Conditional OpenAPI for Japanese to How To

* 📝 Move example source files for Extending OpenAPI into each of the new sections

* ✅ Update tests with new locations for source files

* 🔥 Remove init from Peewee examples
34 files changed:
docs/em/docs/advanced/extending-openapi.md [deleted file]
docs/em/docs/how-to/conditional-openapi.md [moved from docs/em/docs/advanced/conditional-openapi.md with 100% similarity]
docs/em/docs/how-to/custom-request-and-route.md [moved from docs/em/docs/advanced/custom-request-and-route.md with 100% similarity]
docs/em/docs/how-to/extending-openapi.md [new file with mode: 0644]
docs/em/docs/how-to/graphql.md [moved from docs/em/docs/advanced/graphql.md with 100% similarity]
docs/em/docs/how-to/sql-databases-peewee.md [moved from docs/em/docs/advanced/sql-databases-peewee.md with 100% similarity]
docs/en/docs/advanced/extending-openapi.md [deleted file]
docs/en/docs/how-to/async-sql-encode-databases.md [moved from docs/en/docs/advanced/async-sql-databases.md with 98% similarity]
docs/en/docs/how-to/conditional-openapi.md [moved from docs/en/docs/advanced/conditional-openapi.md with 100% similarity]
docs/en/docs/how-to/configure-swagger-ui.md [new file with mode: 0644]
docs/en/docs/how-to/custom-docs-ui-assets.md [new file with mode: 0644]
docs/en/docs/how-to/custom-request-and-route.md [moved from docs/en/docs/advanced/custom-request-and-route.md with 100% similarity]
docs/en/docs/how-to/extending-openapi.md [new file with mode: 0644]
docs/en/docs/how-to/general.md [new file with mode: 0644]
docs/en/docs/how-to/graphql.md [moved from docs/en/docs/advanced/graphql.md with 100% similarity]
docs/en/docs/how-to/index.md [new file with mode: 0644]
docs/en/docs/how-to/nosql-databases-couchbase.md [moved from docs/en/docs/advanced/nosql-databases.md with 99% similarity]
docs/en/docs/how-to/sql-databases-peewee.md [moved from docs/en/docs/advanced/sql-databases-peewee.md with 99% similarity]
docs/en/mkdocs.yml
docs/ja/docs/how-to/conditional-openapi.md [moved from docs/ja/docs/advanced/conditional-openapi.md with 100% similarity]
docs_src/configure_swagger_ui/tutorial001.py [moved from docs_src/extending_openapi/tutorial003.py with 100% similarity]
docs_src/configure_swagger_ui/tutorial002.py [moved from docs_src/extending_openapi/tutorial004.py with 100% similarity]
docs_src/configure_swagger_ui/tutorial003.py [moved from docs_src/extending_openapi/tutorial005.py with 100% similarity]
docs_src/custom_docs_ui/tutorial001.py [new file with mode: 0644]
docs_src/custom_docs_ui/tutorial002.py [moved from docs_src/extending_openapi/tutorial002.py with 100% similarity]
requirements-tests.txt
tests/test_tutorial/test_configure_swagger_ui/__init__.py [moved from docs_src/sql_databases_peewee/__init__.py with 100% similarity]
tests/test_tutorial/test_configure_swagger_ui/test_tutorial001.py [moved from tests/test_tutorial/test_extending_openapi/test_tutorial003.py with 95% similarity]
tests/test_tutorial/test_configure_swagger_ui/test_tutorial002.py [moved from tests/test_tutorial/test_extending_openapi/test_tutorial004.py with 96% similarity]
tests/test_tutorial/test_configure_swagger_ui/test_tutorial003.py [moved from tests/test_tutorial/test_extending_openapi/test_tutorial005.py with 96% similarity]
tests/test_tutorial/test_custom_docs_ui/__init__.py [moved from tests/test_tutorial/test_sql_databases_peewee/__init__.py with 100% similarity]
tests/test_tutorial/test_custom_docs_ui/test_tutorial001.py [new file with mode: 0644]
tests/test_tutorial/test_custom_docs_ui/test_tutorial002.py [moved from tests/test_tutorial/test_extending_openapi/test_tutorial002.py with 95% similarity]
tests/test_tutorial/test_sql_databases_peewee/test_sql_databases_peewee.py [deleted file]