Skip to content

Commit

Permalink
docs/config.rst: State in config directive sections their ini file se…
Browse files Browse the repository at this point in the history
…ctions

The config file documentation is in essentially three parts: config files
and their sections, directives for the global config section, and
directives for the environment sections. For the second and third parts,
state again what config file sections they belong in.

(This is arguably redundant, but the page as a whole is long enough that
it's good to clarify this at the head of the directives in the not-unlikely
case that a new user didn't carefully peruse and understand the initial
section.)
  • Loading branch information
0cjs committed Jan 20, 2024
1 parent 5054a86 commit e973166
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/changelog/3194.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Configuration: state in config directive sections their ini file sections - by :user:`0cjs`.
4 changes: 4 additions & 0 deletions docs/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,8 @@ examples first and use this page as a reference.
Core
----

The following options are set in the ``[tox]`` section of ``tox.ini`` or the ``[tox:tox]`` section of ``setup.cfg``.

.. conf::
:keys: requires
:default: <empty list>
Expand Down Expand Up @@ -237,6 +239,8 @@ Python language core options
tox environment
---------------

The following options are set in the ``[testenv]`` or ``[testenv:*]`` sections of ``tox.ini`` or ``setup.cfg``.

Base options
~~~~~~~~~~~~

Expand Down

0 comments on commit e973166

Please sign in to comment.