Skip to content


Subversion checkout URL

You can clone with
Download ZIP
documentation testing framework
Pull request Compare This branch is even with tychoish:master.
Fetching latest commit...
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
cases Infrastructure to resolve #65: abstracting results capturing and inte…
docs minor: fixing docs
dtf minor: whitespace
test testing infrastructure and make improvements
tests adding support for multi-document yaml files
.gitignore infrastructure: release eng, dev tools
README.rst fixing typo, thanks mike!
makefile meta: making tags generation work
requirements.txt adding gevent support and required refactoring ongoing import clean up, making optional modules optional testing infrastructure and make improvements


Document Test Framework (dtf)

dtf is a test runner, designed to help coordinate and enforce consistency requirements for large documentation projects, though its implementation may be more broadly useful. Ideally dtf will help facilitate easy, regular and automated testing for documentation source and production output, and ease the burden of manual consistency editing and checking, and help increase the quality of tests without increasing the workload for editors and documentation maintainers.

dtf does not run Python unittest tests or coordinate with existing test frameworks (at this time.)


The dtf tutorial provides a complete introduction to dtf and its operation. See the dtf API documentation for a full account of the implementation of dtf.
Issue Tracker
File bugs or enhancement requests on To discuss development use the institute listserv.

The main git repository for dtf is accessible via http at <> with gitweb. You can also see the mirror at github and submit changes to dtf either via email/issue tracker (i.e. patches,) or via github's pull requests.

In addition to the most up to date version of the dtf code, the repositories also contain a full suite of example test specs and case definitions.

PyPI Package
All releases of the core dtf program are on PyPi at: <>.
Something went wrong with that request. Please try again.