Port details on branch 2022Q2 |
- py-collective.checkdocs View and validate restructured text in package's long_description
- 0.2 textproc =0 0.2Version of this port present on the latest quarterly branch.
- Maintainer: egypcio@FreeBSD.org
- Port Added: 2020-11-14 19:44:46
- Last Update: 2023-06-27 19:34:34
- Commit Hash: 3d9a815
- Also Listed In: devel python
- License: GPLv2
- WWW:
- https://github.com/collective/collective.checkdocs
- 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.
- ¦ ¦ ¦ ¦
- Manual pages:
- FreshPorts has no man page information for this port.
- pkg-plist: as obtained via:
make generate-plist - There is no configure plist information for this port.
- Dependency lines:
-
- ${PYTHON_PKGNAMEPREFIX}collective.checkdocs>0:textproc/py-collective.checkdocs@${PY_FLAVOR}
- To install the port:
- cd /usr/ports/textproc/py-collective.checkdocs/ && make install clean
- To add the package, run one of these commands:
- pkg install textproc/py-collective.checkdocs
- pkg install py39-collective.checkdocs
NOTE: If this package has multiple flavors (see below), then use one of them instead of the name specified above. NOTE: This is a Python port. Instead of py39-collective.checkdocs listed in the above command, you can pick from the names under the Packages section.- PKGNAME: py39-collective.checkdocs
- Package flavors (<flavor>: <package>)
- py39: py39-collective.checkdocs
- distinfo:
- TIMESTAMP = 1605029614
SHA256 (collective.checkdocs-0.2.zip) = 3a5328257c5224bc72753820c182910d7fb336bc1dba5e09113d48566655e46e
SIZE (collective.checkdocs-0.2.zip) = 10865
Packages (timestamps in pop-ups are UTC):
- Dependencies
- NOTE: FreshPorts displays only information on required and default dependencies. Optional dependencies are not covered.
- Build dependencies:
-
- py39-setuptools>=63.1.0 : devel/py-setuptools@py39
- python3.9 : lang/python39
- Test dependencies:
-
- python3.9 : lang/python39
- Runtime dependencies:
-
- py39-docutils>=0.15 : textproc/py-docutils@py39
- py39-setuptools>=63.1.0 : devel/py-setuptools@py39
- python3.9 : lang/python39
- There are no ports dependent upon this port
Configuration Options:
- No options to configure
- Options name:
- textproc_py-collective.checkdocs
- USES:
- python zip
- FreshPorts was unable to extract/find any pkg message
- Master Sites:
|