# Sybil documentation

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 three main Python test runners. 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.

- Usage
  - Method of operation
  - Test runner integration
    - pytest
    - unittest
    - nose
- Parsers
  - doctest
  - codeblock
  - capture
  - skip
  - Developing your own parsers
- API Reference
- Development
  - Setting up a virtualenv
  - Running the tests
  - Building the documentation
  - Making a release
- Changes
  - 1.2.0 (28 Apr 2019)
  - 1.1.0 (25 Apr 2019)
  - 1.0.9 (1 Aug 2018)
  - 1.0.8 (6 Apr 2018)
  - 1.0.7 (25 January 2018)
  - 1.0.6 (30 November 2017)
  - 1.0.5 (6 June 2017)
  - 1.0.4 (5 June 2017)
  - 1.0.3 (2 June 2017)
  - 1.0.2 (1 June 2017)
  - 1.0.1 (30 May 2017)
  - 1.0.0 (26 May 2017)
- License

# 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 Fawtly Towers character name for this library.

# Indices and tables

- Index
- Module Index
- Search Page