From ee6ea371619ae3ab6b2279495cf421f72d39bdd9 Mon Sep 17 00:00:00 2001 From: DanCardin Date: Wed, 5 Oct 2022 09:59:09 -0400 Subject: [PATCH] fix: Docs build. (#168) --- docs/source/fixtures.rst | 10 ++++++++++ readthedocs.yml | 6 +++--- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/source/fixtures.rst b/docs/source/fixtures.rst index 339f8747..887a1e9c 100644 --- a/docs/source/fixtures.rst +++ b/docs/source/fixtures.rst @@ -11,6 +11,16 @@ A new resource (database or otherwise) is created on a per test database, which fixture to be used in multiple tests without risking data leakage or side-effects from one test to another. +.. note:: + + By default the underlying containers are reused across tests to amortize the container startup + cost. Tests then create new "resources" (e.g. databases) within that container to avoid + inter-test pollution. + + This **can** cause inter-test dependencies if your tests are altering container-global resources + like database users. In the event this is a problem, resources can be configured to **not** + be session fixtures, although this will likely be drastically slower overall. + See :ref:`Config` for information on customizing the configuration for docker-based fixtures. .. toctree:: diff --git a/readthedocs.yml b/readthedocs.yml index a11386e0..e27bf14e 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -1,9 +1,9 @@ build: - image: latest + image: latest python: - version: 3.6 - pip_install: true + version: 3.7 + pip_install: true requirements: docs/requirements.txt sphinx: