Skip to main content

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

Project description

collective.checkdocs

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 plone.org. 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 setup.py installers.

checkdocs

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.

Example:

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

showdocs

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.

Example:

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

Resources

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

collective.checkdocs-0.1.tar.gz (3.4 kB view details)

Uploaded Source

File details

Details for the file collective.checkdocs-0.1.tar.gz.

File metadata

File hashes

Hashes for collective.checkdocs-0.1.tar.gz
Algorithm Hash digest
SHA256 994ac0a41b2336e3791b683fbcc39eeba210d82dedf96323a85dfc056decdc0c
MD5 f0944569d56e1a8f6775e84ef7046651
BLAKE2b-256 9725c82104841c4ea3bc6e1dd4c4663374820570e11b55f573125a66c94d9348

See more details on using hashes here.

Supported by

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