Skip to main content

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinxcontrib-redpen, version 0.0.2
Filename, size & hash File type Python version Upload date
sphinxcontrib-redpen-0.0.2.tar.gz (3.5 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page