[TIP] Sybil 1.0.0 Released!
chris at withers.org
Fri May 26 00:41:08 PDT 2017
I'm pleased to announce the first release of Sybil, a library to help
you test the examples in your documents.
For example, given the following Sphinx source file:
Let's put something in the Sybil document's namespace:
.. invisible-code-block: python
remember_me = b'see how namespaces work?'
Suppose we define a function, convoluted and pointless but shows
.. code-block:: python
Now we can use a doctest REPL to show it in action:
prefix: see how namespaces work?
The namespace carries across from example to example, no matter
b'see how namespaces work?'
All the examples can be tested when using pytest by putting the
following in a conftest.py in your Sphinx source directory:
from doctest import ELLIPSIS
from sybil import Sybil
from sybil.parsers.codeblock import CodeBlockParser
from sybil.parsers.doctest import DocTestParser, FIX_BYTE_UNICODE_REPR
pytest_collect_file = Sybil(
The package is on PyPI and a full list of all the links to docs, issue
trackers and the like can be found here:
Any questions, please do ask on the Testing in Python list or on the
Simplistix open source mailing list...
PS: The name comes from Fawlty Towers, as this package is heavily
inspired by Benji York's fantastic Manuel package, which also took it's
name from the series!
More information about the testing-in-python