Skip to content

Commit 4fc20c8

Browse files
committed
List pytest-doctestplus in doctest docs
As per #8088
1 parent 954151c commit 4fc20c8

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

doc/en/doctest.rst

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -77,15 +77,6 @@ putting them into a pytest.ini file like this:
7777
[pytest]
7878
addopts = --doctest-modules
7979
80-
.. note::
81-
82-
The builtin pytest doctest supports only ``doctest`` blocks, but if you are looking
83-
for more advanced checking over *all* your documentation,
84-
including doctests, ``.. codeblock:: python`` Sphinx directive support,
85-
and any other examples your documentation may include, you may wish to
86-
consider `Sybil <https://sybil.readthedocs.io/en/latest/index.html>`__.
87-
It provides pytest integration out of the box.
88-
8980
9081
Encoding
9182
--------
@@ -303,3 +294,18 @@ docstring.
303294

304295
* Text files: the functions will skip/xfail the checks for the rest of the entire
305296
file.
297+
298+
299+
Alternatives
300+
------------
301+
302+
While the built-in pytest support provides a good set of functionalities for using
303+
doctests, if you use them extensively you might be interested in those external packages
304+
which add many more features, and include pytest integration:
305+
306+
* `pytest-doctestplus <https://github.com/astropy/pytest-doctestplus>`__: provides
307+
advanced doctest support and enables the testing of reStructuredText (".rst") files.
308+
309+
* `Sybil <https://sybil.readthedocs.io>`__: provides a way to test examples in
310+
your documentation by parsing them from the documentation source and evaluating
311+
the parsed examples as part of your normal test run.

0 commit comments

Comments
 (0)