File: README.rst

package info (click to toggle)
sphinx-testing 0.7.1-2~bpo8+1
  • links: PTS
  • area: main
  • in suites: jessie-backports
  • size: 188 kB
  • sloc: python: 696; makefile: 16
file content (37 lines) | stat: -rw-r--r-- 656 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
==============
sphinx-testing
==============

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


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