File tree Expand file tree Collapse file tree 1 file changed +15
-9
lines changed Expand file tree Collapse file tree 1 file changed +15
-9
lines changed Original file line number Diff line number Diff line change @@ -77,15 +77,6 @@ putting them into a pytest.ini file like this:
77
77
[pytest]
78
78
addopts = --doctest-modules
79
79
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
-
89
80
90
81
Encoding
91
82
--------
@@ -303,3 +294,18 @@ docstring.
303
294
304
295
* Text files: the functions will skip/xfail the checks for the rest of the entire
305
296
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.
You can’t perform that action at this time.
0 commit comments