diff options
author | VinÃcius Zavam <egypcio@FreeBSD.org> | 2020-11-14 19:42:39 +0000 |
---|---|---|
committer | VinÃcius Zavam <egypcio@FreeBSD.org> | 2020-11-14 19:42:39 +0000 |
commit | f0ea368ac6b3d57e066779313ebfd09d4388f476 (patch) | |
tree | cb7963008aa7fb076136c7b5545204a8d80d5ef8 /textproc/py-collective.checkdocs | |
parent | 40a197f0f4d7bf277aebde91b3d7c2b1bfa78d16 (diff) | |
download | ports-f0ea368ac6b3d57e066779313ebfd09d4388f476.tar.gz ports-f0ea368ac6b3d57e066779313ebfd09d4388f476.zip |
[NEW] textproc/py-collective.checkdocs: view and validate w/ long_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.
WWW: https://github.com/collective/collective.checkdocs
Notes
Notes:
svn path=/head/; revision=555141
Diffstat (limited to 'textproc/py-collective.checkdocs')
-rw-r--r-- | textproc/py-collective.checkdocs/Makefile | 21 | ||||
-rw-r--r-- | textproc/py-collective.checkdocs/distinfo | 3 | ||||
-rw-r--r-- | textproc/py-collective.checkdocs/pkg-descr | 15 |
3 files changed, 39 insertions, 0 deletions
diff --git a/textproc/py-collective.checkdocs/Makefile b/textproc/py-collective.checkdocs/Makefile new file mode 100644 index 000000000000..e5b0b16bd917 --- /dev/null +++ b/textproc/py-collective.checkdocs/Makefile @@ -0,0 +1,21 @@ +# $FreeBSD$ + +PORTNAME= collective.checkdocs +PORTVERSION= 0.2 +CATEGORIES= textproc devel python +MASTER_SITES= CHEESESHOP +PKGNAMEPREFIX= ${PYTHON_PKGNAMEPREFIX} + +MAINTAINER= egypcio@FreeBSD.org +COMMENT= View and validate restructured text in package's long_description + +LICENSE= GPLv2 + +RUN_DEPENDS= ${PYTHON_PKGNAMEPREFIX}docutils>=0.15:textproc/py-docutils@${PY_FLAVOR} + +USES= python zip +USE_PYTHON= autoplist concurrent distutils + +NO_ARCH= yes + +.include <bsd.port.mk> diff --git a/textproc/py-collective.checkdocs/distinfo b/textproc/py-collective.checkdocs/distinfo new file mode 100644 index 000000000000..29c8fff5ca8b --- /dev/null +++ b/textproc/py-collective.checkdocs/distinfo @@ -0,0 +1,3 @@ +TIMESTAMP = 1605029614 +SHA256 (collective.checkdocs-0.2.zip) = 3a5328257c5224bc72753820c182910d7fb336bc1dba5e09113d48566655e46e +SIZE (collective.checkdocs-0.2.zip) = 10865 diff --git a/textproc/py-collective.checkdocs/pkg-descr b/textproc/py-collective.checkdocs/pkg-descr new file mode 100644 index 000000000000..c75a744b622f --- /dev/null +++ b/textproc/py-collective.checkdocs/pkg-descr @@ -0,0 +1,15 @@ +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. + +WWW: https://github.com/collective/collective.checkdocs |