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
before submitting eggs to PyPi.
Installation
============
Install this to your development Python run-time::
easy_install collective.checkdocs
*Note*: On OSX at least Python version 2.5 or newer is required.
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 or 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 web browser. 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
Source code
------------
* https://svn.plone.org/svn/collective/collective.checkdocs
Authors
-------
`Mikko Ohtamaa <https://opensourcehacker.com>`_
Resources
---------
* long_description text is `restructured formatted <http://docutils.sourceforge.net/rst.html>`_
* `docutils <http://docutils.sourceforge.net/>`_
* `rstctl (inspiration and sources) <http://pypi.python.org/pypi/rstctl>`_
* `How it all begun <http://www.nabble.com/Checking-long_description-format-(reST)-before-it-is-sent-to-PyPI-td15613184.html>`_
Raw data
{
"_id": null,
"home_page": "https://github.com/collective/collective.checkdocs",
"name": "collective.checkdocs",
"maintainer": "",
"docs_url": null,
"requires_python": null,
"maintainer_email": "",
"keywords": "rest distutils egg validator check validation restructured text html documentation",
"author": "mFabrik Research Oy",
"author_email": "info@mfabrik.com",
"download_url": "https://files.pythonhosted.org/packages/b3/3b/2d3f1d3685ae820f0f7076d098a51d6c65493d086f0101556e8cc28bbb86/collective.checkdocs-0.2.zip",
"platform": "UNKNOWN",
"description": "collective.checkdocs adds new distutils commands ``checkdocs`` and ``showdocs`` to validate restructured text in long_description field of Python eggs. \r\nThis package aims to make Python egg help page publishing and editing easier.\r\n\r\nEggs' long description field, which is usually also the README.txt file of the package, is reST formatted text. This text is converted\r\nto HTML to show on the package page when package is published in distribution repositories like PyPI or plone.org.\r\nUnfortunately, since repositories do poor job to validate incoming reST text, errors in the text will result to broken published\r\npackage pages. \r\n\r\nUnpublishing is usually very cumbersome. \r\nWe save our time by validating reST input using ``checkdocs`` and ``showdocs`` commands\r\nbefore submitting eggs to PyPi.\r\n\r\nInstallation\r\n============\r\n\r\nInstall this to your development Python run-time::\r\n\r\n easy_install collective.checkdocs\r\n\r\n\r\n*Note*: On OSX at least Python version 2.5 or newer is required.\r\n \r\nNew commands\r\n============\r\n\r\nThe following commands will be added to all setup.py installers.\r\n\r\ncheckdocs\r\n---------\r\n\r\nRun long_description through reST to HTML converter and print errors and warnings to the standard output.\r\n\r\nAny errors or warnings will cause distutils to abort.\r\n\r\nExample::\r\n\r\n python setup.py checkdocs\r\n <string>:4: (WARNING/2) Inline literal start-string without end-string.\r\n error: long_description had reST syntax errors\r\n\r\nshowdocs\r\n---------\r\n\r\nRun long_description through reST to HTML converter and display the result in a local web browser. Runs a web server in port 6969 until CTRL+C is pressed.\r\n\r\nExample::\r\n\r\n python setup.py showdocs\r\n running showdocs\r\n reST to HTML conversion available at at http://localhost:6969/ - press CTRL+C to interrupt\r\n\r\nSource code\r\n------------\r\n\r\n* https://svn.plone.org/svn/collective/collective.checkdocs\r\n\r\nAuthors\r\n-------\r\n\r\n`Mikko Ohtamaa <https://opensourcehacker.com>`_ \r\n\r\nResources\r\n---------\r\n\r\n* long_description text is `restructured formatted <http://docutils.sourceforge.net/rst.html>`_\r\n\r\n* `docutils <http://docutils.sourceforge.net/>`_\r\n\r\n* `rstctl (inspiration and sources) <http://pypi.python.org/pypi/rstctl>`_\r\n\r\n* `How it all begun <http://www.nabble.com/Checking-long_description-format-(reST)-before-it-is-sent-to-PyPI-td15613184.html>`_",
"bugtrack_url": null,
"license": "GPL",
"summary": "Distutils command to view and validate restructured text in package's long_description",
"version": "0.2",
"split_keywords": [
"rest",
"distutils",
"egg",
"validator",
"check",
"validation",
"restructured",
"text",
"html",
"documentation"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "472a6c7cafad4ee274c905ebd1603fb3",
"sha256": "3a5328257c5224bc72753820c182910d7fb336bc1dba5e09113d48566655e46e"
},
"downloads": -1,
"filename": "collective.checkdocs-0.2.zip",
"has_sig": false,
"md5_digest": "472a6c7cafad4ee274c905ebd1603fb3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10865,
"upload_time": "2014-06-06T10:05:03",
"upload_time_iso_8601": "2014-06-06T10:05:03.747421Z",
"url": "https://files.pythonhosted.org/packages/b3/3b/2d3f1d3685ae820f0f7076d098a51d6c65493d086f0101556e8cc28bbb86/collective.checkdocs-0.2.zip",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2014-06-06 10:05:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "collective",
"github_project": "collective.checkdocs",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "collective.checkdocs"
}
JSON
