diff --git a/changelog/1495.doc.rst b/changelog/1495.doc.rst new file mode 100644 index 000000000..ab7231333 --- /dev/null +++ b/changelog/1495.doc.rst @@ -0,0 +1 @@ +Document common doctest fixture directory tree structure pitfalls diff --git a/doc/en/doctest.rst b/doc/en/doctest.rst index 52edd4cf2..125ed3aa7 100644 --- a/doc/en/doctest.rst +++ b/doc/en/doctest.rst @@ -154,6 +154,9 @@ which can then be used in your doctests directly:: """ pass +Note that like the normal ``conftest.py``, the fixtures are discovered in the directory tree conftest is in. +Meaning that if you put your doctest with your source code, the relevant conftest.py needs to be in the same directory tree. +Fixtures will not be discovered in a sibling directory tree! Output format -------------