40 lines
1.1 KiB
Plaintext
40 lines
1.1 KiB
Plaintext
|
|
pytest_restdoc plugin
|
|
=====================
|
|
|
|
perform ReST syntax, local and remote reference tests on .rst/.txt files.
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
|
|
|
|
command line options
|
|
--------------------
|
|
|
|
|
|
``-R, --urlcheck``
|
|
urlopen() remote links found in ReST text files.
|
|
``--urltimeout=secs``
|
|
timeout in seconds for remote urlchecks
|
|
``--forcegen``
|
|
force generation of html files.
|
|
|
|
Start improving this plugin in 30 seconds
|
|
=========================================
|
|
|
|
|
|
Do you find the above documentation or the plugin itself lacking?
|
|
|
|
1. Download `pytest_restdoc.py`_ plugin source code
|
|
2. put it somewhere as ``pytest_restdoc.py`` into your import path
|
|
3. a subsequent ``py.test`` run will use your local version
|
|
|
|
Further information: extend_ documentation, other plugins_ or contact_.
|
|
|
|
.. _`pytest_restdoc.py`: http://bitbucket.org/hpk42/py-trunk/raw/6e9879aca934933c6065776820f22095634a7edf/py/test/plugin/pytest_restdoc.py
|
|
.. _`extend`: ../extend.html
|
|
.. _`plugins`: index.html
|
|
.. _`contact`: ../../contact.html
|
|
.. _`checkout the py.test development version`: ../../download.html#checkout
|