Skip to content

Commit 43e4ef0

Browse files
sobolevnintgradamchainz
authored
Add "Settings" section to README (#1581)
* Add "Settings" section to README * Update README.md Co-authored-by: Marti Raudsepp <[email protected]> * Update README.md Co-authored-by: Marti Raudsepp <[email protected]> * Update README.md Co-authored-by: Adam Johnson <[email protected]> --------- Co-authored-by: Marti Raudsepp <[email protected]> Co-authored-by: Adam Johnson <[email protected]>
1 parent bbd0636 commit 43e4ef0

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,23 @@ class MyModel(models.Model):
8080

8181
* `django_stubs_ext.db.router.TypedDatabaseRouter` can be used as base when implementing custom database routers.
8282

83+
## Settings
84+
85+
django-stubs has a few settings, which you can list in:
86+
87+
* `pyproject.toml`, under the table `[tool.django-stubs]`
88+
* `mypy.ini` under the table `[mypy.plugins.django-stubs]`
89+
90+
The supported settings are:
91+
92+
- `django_settings_module`, a string.
93+
94+
Specify the import path of your settings module, the same as Django’s [`DJANGO_SETTINGS_MODULE` environment variable](https://docs.djangoproject.com/en/stable/topics/settings/#designating-the-settings).
95+
96+
- `strict_settings`, a boolean, default `true`.
97+
98+
Set to `false` if using dynamic settings, as [described below](https://github.com/typeddjango/django-stubs#how-to-use-a-custom-library-to-handle-django-settings).
99+
83100
## FAQ
84101

85102
### Is this an official Django project?

0 commit comments

Comments
 (0)