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.

Source Distribution

sphinxcontrib-redpen-0.0.2.tar.gz (3.5 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page