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)
Metadata
Release files for sphinxcontrib-redpen 0.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinxcontrib-redpen-0.0.2.tar.gz | 3.5 kB | Details |
Release files / sphinxcontrib-redpen-0.0.2.tar.gz
| Download URL | sphinxcontrib-redpen-0.0.2.tar.gz |
|---|---|
| Size | 3.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
580bb7b4bbf151de115c2fce3152691ef90e2571298d76d9647c54eaa7b4375d
|
|
BLAKE2b-256 checksum How to use checksums |
efa07acf0343b575c0dbef4d87841526c26d948de193f0717aaafcadeeb57778
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |