Add setting example using pyproject.toml file. (#1047)

Author: Bernardoow

docs/configuring_django.rst

@@ -38,6 +38,14 @@ Example contents of pytest.ini::
     [pytest]
     DJANGO_SETTINGS_MODULE = test.settings
 
+``pyproject.toml`` settings
+---------------------------
+
+Example contents of pyproject.toml::
+
+    [tool.pytest.ini_options]
+    DJANGO_SETTINGS_MODULE = "test.settings"
+
 Order of choosing settings
 --------------------------
 
@@ -46,7 +54,7 @@ The order of precedence is, from highest to lowest:
 * The command line option ``--ds``
 * The environment variable ``DJANGO_SETTINGS_MODULE``
 * The ``DJANGO_SETTINGS_MODULE`` option in the configuration file -
-  ``pytest.ini``, or other file that Pytest finds such as ``tox.ini``
+  ``pytest.ini``, or other file that Pytest finds such as ``tox.ini`` or ``pyproject.toml``
 
 If you want to use the highest precedence in the configuration file, you can
 use ``addopts = --ds=yourtestsettings``.
@@ -57,7 +65,7 @@ Using django-configurations
 There is support for using `django-configurations <https://pypi.python.org/pypi/django-configurations/>`_.
 
 To do so configure the settings class using an environment variable, the
-``--dc`` flag, or ``pytest.ini`` option ``DJANGO_CONFIGURATION``.
+``--dc`` flag, ``pytest.ini`` option ``DJANGO_CONFIGURATION`` or ``pyproject.toml`` option ``DJANGO_CONFIGURATION``.
 
 Environment Variable::
 
@@ -73,6 +81,11 @@ INI File Contents::
     [pytest]
     DJANGO_CONFIGURATION=MySettings
 
+pyproject.toml File Contents::
+
+    [tool.pytest.ini_options]
+    DJANGO_CONFIGURATION = "MySettings"
+
 Using ``django.conf.settings.configure()``
 ------------------------------------------
 

docs/index.rst

@@ -19,6 +19,9 @@ Make sure ``DJANGO_SETTINGS_MODULE`` is defined (see
 :ref:`configuring_django_settings`) and make your tests discoverable
 (see :ref:`faq-tests-not-being-picked-up`):
 
+Example using pytest.ini or tox.ini
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 .. code-block:: ini
 
    # -- FILE: pytest.ini (or tox.ini)
@@ -27,6 +30,17 @@ Make sure ``DJANGO_SETTINGS_MODULE`` is defined (see
    # -- recommended but optional:
    python_files = tests.py test_*.py *_tests.py
 
+Example using pyproject.toml
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: toml
+
+   # -- Example FILE: pyproject.toml
+   [tool.pytest.ini_options]
+   DJANGO_SETTINGS_MODULE = "test.settings"
+   # -- recommended but optional:
+   python_files = ["test_*.py", "*_test.py", "testing/python/*.py"]
+
 Run your tests with ``pytest``:
 
 .. code-block:: bash

docs/tutorial.rst

@@ -54,6 +54,13 @@ contains:
     [pytest]
     DJANGO_SETTINGS_MODULE = yourproject.settings
 
+Another options for people that use ``pyproject.toml`` is add the following code:
+
+.. code-block:: toml
+
+    [tool.pytest.ini_options]
+    DJANGO_SETTINGS_MODULE = "yourproject.settings"
+
 You can also specify your Django settings by setting the
 ``DJANGO_SETTINGS_MODULE`` environment variable or specifying the
 ``--ds=yourproject.settings`` command line flag when running the tests.