diff options
| author | Bernat Gabor <gaborjbernat@gmail.com> | 2018-09-16 13:04:43 +0100 |
|---|---|---|
| committer | Bernát Gábor <gaborjbernat@gmail.com> | 2018-09-16 15:35:39 +0300 |
| commit | f3c5b7b74626a1b67a0c3ebe9ae71289ef8d6156 (patch) | |
| tree | ccae4c6166db1353b1a1fd53e6bfb240deaecce6 | |
| parent | 77eb64a492067a5e7bdfb4b02e48989d201ecaa0 (diff) | |
| download | tox-git-f3c5b7b74626a1b67a0c3ebe9ae71289ef8d6156.tar.gz | |
specify that ``setup.cfg`` tox configuration needs to be inside the ``tox:tox`` namespace #545
| -rw-r--r-- | changelog/545.doc.rst | 1 | ||||
| -rw-r--r-- | doc/config.rst | 12 |
2 files changed, 7 insertions, 6 deletions
diff --git a/changelog/545.doc.rst b/changelog/545.doc.rst new file mode 100644 index 00000000..51874285 --- /dev/null +++ b/changelog/545.doc.rst @@ -0,0 +1 @@ +specify that ``setup.cfg`` tox configuration needs to be inside the ``tox:tox`` namespace - by :user:`gaborbernat` diff --git a/doc/config.rst b/doc/config.rst index 95e7fd85..89ce7a3a 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -5,15 +5,15 @@ tox configuration specification tox supports at the moment three locations for specifying the configuration, in the following priority order: -1. ``pyproject.toml`` -2. ``tox.ini`` -3. ``setup.cfg`` +1. ``pyproject.toml``, +2. ``tox.ini``, +3. ``setup.cfg``. As far as the configuration format at the moment we only support standard ConfigParser_ "ini-style" format (there is a plan to add a pure TOML one soon). -``tox.ini`` and ``setup.cfg`` are files are fully such files. ``pyproject.toml`` on the other hand is a TOML -format. However, one can inline the *ini-style* format under the ``tool.tox.legacy_tox_ini`` key as a multi-line -string. +``tox.ini`` and ``setup.cfg`` are files are fully such files. Note ``setup.cfg`` requires the content to be under +``tox:tox`` section. ``pyproject.toml`` on the other hand is a TOML format. However, one can inline the *ini-style* format under +the ``tool.tox.legacy_tox_ini`` key as a multi-line string. Below you find the specification for the *ini-style* format, but you might want to skim some :doc:`examples` first and use this page as a reference. |