sphinxcontrib-shtest 0.5.0

Examples

# Obligatory hello world example.
$ echo hello world
hello world

:stderr:

# Read from stderr instead of stdout.
$ echo message on stderr >&2
message on stderr

:returncode: 1

# Use a non-zero expected return code.
$ false

# Run multiple tests in one directive.
$ echo hello
hello
$ echo world
world

:cwd: tests

# Run a test in a particular working directory relative to the document.
$ cat hello.txt
world

:tempdir:

# Run a test in a temporary directory.
$ echo hello > world.txt

Installation

Run pip install sphinxcontrib-shtest to install the package and add "sphinxcontrib.shtest" to your extensions list in conf.py (see here for details). Then execute sphinx-build -b shtest /path/to/source/directory /path/to/output/directory.