33 lines
760 B
Plaintext
33 lines
760 B
Plaintext
|
|
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
|
|
=========================================
|
|
|
|
|
|
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
|
|
|
|
Checkout customize_, other plugins_ or `get in contact`_.
|
|
|
|
.. include:: links.txt
|