testing utility classes and functions for Sphinx extensions

Navigation

Verified details

These details have been verified by PyPI
Owner
Maintainers
Avatar for AA-Turner from gravatar.com AA-Turner

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: BSD License (UNKNOWN)
  • Author: Takeshi Komiya
  • Tags sphinx , testing
Classifiers
Report project as malware

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

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

Latest PyPI version Number of PyPI downloads

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):
    app.build()
    html = (app.outdir / 'index.html').read_text()
    assert '<h1>Hello world</h1>' in html

Requirements

  • Python 2.6, 2.7, 3.3 or later

  • Sphinx 0.6 or later

  • six

License

BSD License

Supported by

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