detroit-qed - run qed demonstrandum using detroit
The QED plug-in for Detroit utilizes the QED test framework to run tests during the standard test phase. It can also be used to unify QED demonstrandum into a single document suitable for inclusion in documentation.
This plug-in package also includes detroit-qedoc(5).
The following options can be used in the Detroit assembly file for defining a qed service.
files - Demonstrandum files to run (or globs there-of).
omit - File patterns to omit from
format - Output format.
mode - Parse mode.
loadpath - Paths to be added to
requires - Libraries to be required before running demonstrandum.
rooted - Operate from project root, instead of
profile - Select a profile.
The defaults are often sifficiant. So an entry can be as simple as:
qed: active: true
A more typical example might be:
qed: files: spec/ format: verbatim
The above examples use the YAML-base assembly format. Assembly files can also be Ruby-based. See Detroit documentation for more details.
For more information:
Copyright (c) 2010 Thomas Sawyer, Rubyworks
Detroit QED is distributable in accordance with the GPLv3 license.
detroit(1), qed(1), detroit-qedoc(5)