CircleCI Docs

This library provides a way to test examples in your documentation by parsing them from the documentation source and evaluating the parsed examples as part of your normal test run. Integration is provided for the main Python test runners.

The documentation is the best place to start.

Sybil is designed so that it’s easy to provide your own parsers for your own types of example in addition to the included parsers for doctest and code-block examples.

Why Sybil?

Sybil is heavily inspired by Manuel, which was named after a Fawlty Towers character, and so it seemed only right to pick another Fawlty Towers character name for this library.

Indices and tables