| Description: | The doctestplus plugin provides advanced features for testing example Python
code that is included in Python docstrings and in standalone documentation
files.
Good documentation for developers contains example code. This is true of both
standalone documentation and of documentation that is integrated with the
code itself. Python provides a mechanism for testing code snippets that are
provided in Python docstrings. The unit test framework pytest provides a
mechanism for running doctests against both docstrings in source code and in
standalone documentation files.
This plugin augments the functionality provided by Python and pytest by
providing the following features:
* approximate floating point comparison for doctests that produce floating
point results
* skipping particular classes, methods, and functions when running doctests
* handling doctests that use remote data in conjunction with the
pytest-remotedata plugin
* optional inclusion of *.rst files for doctests |
|---|