textproc/py-collective.checkdocs 0.2_1 DragonFly
View and validate restructured text in package's long_description
- System
- DragonFly
- Repository
- DPorts
- Maintainer
- [email protected] (as in FreeBSD)
- License
- GPLv2
- Categories
- devel, python, textproc
- Package size
- 13.9 KiB, 43.4 KiB installed
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 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.
In the other systems
| System | Port | Version |
|---|---|---|
| DragonFly | textproc/py-collective.checkdocs | 0.2_1 |
| FreeBSD | textproc/py-collective.checkdocs | 0.2_1 |
Install
Binary package:
pkg install py311-collective.checkdocs
From DPorts:
cd /usr/dports/textproc/py-collective.checkdocs && make install clean
Dependencies
Run dependencies 2
No port depends on this one.