Skip to main content

Distutils command to view and validate restructured text in package's long_description

Project description


collective.checkdocs adds new distutils commands checkdocs and showdocs to validate restructured text in long_description field of Python eggs. This package aims to make Python egg help page publishing and editing easier.

Eggs’ long description field, which is usually also the README.txt file of the package, is reST formatted text. This text is converted to HTML to show on the package page when package is published in distribution repositories like PyPI or Unfortunately, since repositories do poor job to validate incoming reST text, errors in the text will result to broken published package pages.

Unpublishing is usually very cumbersome. We save our time by validating reST input using checkdocs and showdocs commands.

New commands

The following commands will be added to all installers.


Run long_description through reST to HTML converter and print errors and warnings to the standard output.

Any errors and warnings will cause distutils to abort.


python checkdocs
<string>:4: (WARNING/2) Inline literal start-string without end-string.
error: long_description had reST syntax errors


Run long_description through reST to HTML converter and display the result in a local webbrowser. Runs a web server in port 6969 until CTRL+C is pressed.


python showdocs
running showdocs
reST to HTML conversion available at at http://localhost:6969/ - press CTRL+C to interrupt

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 collective.checkdocs, version 0.1
Filename, size File type Python version Upload date Hashes
Filename, size collective.checkdocs-0.1.tar.gz (3.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page