No description, website, or topics provided.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src/sphinx_testing
tests
.drone.io.sh
.gitignore
.travis.yml
AUTHORS
CHANGES.rst
LICENSE
MANIFEST.in
README.rst
Sphinx-AUTHORS
setup.cfg
setup.py
tox.ini

README.rst

sphinx-testing

sphinx-testing provides testing utility classes and functions for Sphinx extensions.

https://travis-ci.org/sphinx-doc/sphinx-testing.svg?branch=master https://coveralls.io/repos/sphinx-doc/sphinx-testing/badge.png?branch=master Number of PyPI downloads Wheel Status

Setup

Use easy_install or pip:

$ sudo pip install sphinx-testing

Usage

Example:

from sphinx_testing import with_app

@with_app(buildername='html', srcdir='/path/to/examples', copy_srcdir_to_tmpdir=True)
def test_sphinx_build(app, status, warning):
    app.build()
    html = (app.outdir / 'index.html').read_text()
    assert '<h1>Hello world</h1>' in html

Requirements

  • Python 2.6, 2.7, 3.4 or later
  • Sphinx 0.6 or later
  • six

License

BSD License