Redpen validator for Sphinx
Project description
This extension provides Redpen validator.
install
pip install sphinxcontrib-redpen
and add ‘sphinxcontrib.redpen’ in extensions in your conf.py.
extensions = [ 'sphinxcontrib.redpen', ]
And redpen is also required.
How to use
Config
Set some variables in your conf.py.
- redpen_configfile
Redpen XML config file.
- redpen_server
Redpen server hostname
- redpen_port = 8080
Redpen server port.
- redpen_loglevel
log level
redpen_configfile = 'test.conf.xml' redpen_server = "localhost" redpen_port = 8080 redpen_loglevel = 'info'
Start Redpen Server
You need start redpen-server before use this extension.
$ redpen-server
Then, make html or else.
License
Apache License (same as Redpen)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for sphinxcontrib-redpen-0.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 580bb7b4bbf151de115c2fce3152691ef90e2571298d76d9647c54eaa7b4375d |
|
MD5 | 1141bf9a0bd2d5143fd38caa4714d066 |
|
BLAKE2b-256 | efa07acf0343b575c0dbef4d87841526c26d948de193f0717aaafcadeeb57778 |