Skip to main content

testing utility classes and functions for Sphinx extensions

Project description

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.2 or later

  • Sphinx 0.6 or later

  • six

License

BSD License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-testing-0.7.1.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

sphinx_testing-0.7.1-py2.py3-none-any.whl (6.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sphinx-testing-0.7.1.tar.gz.

File metadata

File hashes

Hashes for sphinx-testing-0.7.1.tar.gz
Algorithm Hash digest
SHA256 0cd235ce939770ae5128eda01d8611fb1e36d8129399e98565f99fcbff3a8062
MD5 0292c02299c00c1bf33c86ac50feaa79
BLAKE2b-256 358ca979dc224de43274b9cbba1cefdcf952599b880f78157969514ba7e35597

See more details on using hashes here.

File details

Details for the file sphinx_testing-0.7.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_testing-0.7.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5e1b41d682a6184d856f40b79ec5924d8281d2f510a16593f9de50da68836b0e
MD5 a355620244449211429a0d4dad77d4e9
BLAKE2b-256 a234a2c4866776024500fd65de491ab464c4581caf7cf36b877b4382a90899e6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page