Skip to content

Commit a1a09e6

Browse files
committed
doc: improved configuration documentation
1 parent 0e02933 commit a1a09e6

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

doc/configuration.rst

+13-5
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,22 @@ Configuration
44
pytest-iam can be configured by redefining or expanding the :meth:`~pytest_iam.iam_configuration` fixture.
55
This returns a :const:`dict` containing the canaille :doc:`canaille:configuration`.
66

7-
.. code:: python
7+
.. code-block:: python
88
99
@pytest.fixture(scope="session")
1010
def iam_configuration(iam_configuration):
11-
iam_configuration["ACL"]["DEFAULT"]["WRITE"].append("groups")
11+
iam_configuration["CANAILLE"]["ACL"]["DEFAULT"]["WRITE"].append("groups")
1212
return iam_configuration
1313
14-
The configuration will also be read:
14+
The configuration will also be read from a `.pytest-iam.env` file if existing.
1515

16-
- from a `.pytest-iam.env` file if existing;
17-
- from any environment var with a valid Canaille setting name prefixed by `PYTEST_IAM_`.
16+
.. code-block:: bash
17+
:caption: .pytest-iam.env
18+
19+
CANAILLE_OIDC__REQUIRE_NONCE=false
20+
21+
It can also be read from any environment var with a valid Canaille setting name prefixed by `PYTEST_IAM_`.
22+
23+
.. code-block:: bash
24+
25+
env PYTEST_IAM_CANAILLE_OIDC__REQUIRE_NONCE=false pytest

0 commit comments

Comments
 (0)