]> git.ipfire.org Git - thirdparty/fastapi/fastapi.git/commit
:memo: Add documentation about settings and env vars (#1118)
authoralexmitelman <alexmitelman@gmail.com>
Thu, 2 Apr 2020 04:55:20 +0000 (07:55 +0300)
committerGitHub <noreply@github.com>
Thu, 2 Apr 2020 04:55:20 +0000 (06:55 +0200)
commitd4d5b21b2e70cdd7e36aedc2e41d7c29b430492b
treebfb2f271697ad954cc55d9744366fcc3dfd1dfb5
parent6e1cd45a46ed4940e37bc3c47d27b9788349ba10
:memo: Add documentation about settings and env vars (#1118)

* Add doc and example for env var config

* Syntax highlight for .env file

* Add test for configuration docs

* :memo: Update settings docs, add more examples

* :white_check_mark: Add tests for settings

* :truck: Rename "Application Configuration" to "Metadata and Docs URLs"

to disambiguate between that and settings

* :fire: Remove replaced example file

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
22 files changed:
docs/en/docs/advanced/settings.md [new file with mode: 0644]
docs/en/docs/img/tutorial/metadata/image01.png [moved from docs/en/docs/img/tutorial/application-configuration/image01.png with 100% similarity]
docs/en/docs/tutorial/metadata.md [moved from docs/en/docs/tutorial/application-configuration.md with 66% similarity]
docs/en/mkdocs.yml
docs_src/metadata/tutorial001.py [moved from docs_src/application_configuration/tutorial001.py with 100% similarity]
docs_src/metadata/tutorial002.py [moved from docs_src/application_configuration/tutorial002.py with 100% similarity]
docs_src/metadata/tutorial003.py [moved from docs_src/application_configuration/tutorial003.py with 100% similarity]
docs_src/settings/app01/__init__.py [moved from tests/test_tutorial/test_application_configuration/__init__.py with 100% similarity]
docs_src/settings/app01/config.py [new file with mode: 0644]
docs_src/settings/app01/main.py [new file with mode: 0644]
docs_src/settings/app02/__init__.py [new file with mode: 0644]
docs_src/settings/app02/config.py [new file with mode: 0644]
docs_src/settings/app02/main.py [new file with mode: 0644]
docs_src/settings/app02/test_main.py [new file with mode: 0644]
docs_src/settings/app03/__init__.py [new file with mode: 0644]
docs_src/settings/app03/config.py [new file with mode: 0644]
docs_src/settings/app03/main.py [new file with mode: 0644]
docs_src/settings/tutorial001.py [new file with mode: 0644]
tests/test_tutorial/test_metadata/__init__.py [new file with mode: 0644]
tests/test_tutorial/test_metadata/test_tutorial001.py [moved from tests/test_tutorial/test_application_configuration/test_tutorial001.py with 94% similarity]
tests/test_tutorial/test_settings/__init__.py [new file with mode: 0644]
tests/test_tutorial/test_settings/test_app02.py [new file with mode: 0644]