BSD Ports

textproc/py-collective.checkdocs 0.2_1 FreeBSD

View and validate restructured text in package's long_description

System
FreeBSD
Repository
FreeBSD ports
Maintainer
[email protected]
License
GPLv2
Categories
textproc, devel, python
Package size
14.9 KiB, 41.5 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

SystemPortVersion
FreeBSDtextproc/py-collective.checkdocs0.2_1
DragonFlytextproc/py-collective.checkdocs0.2_1

Install

Binary package:

pkg install py312-collective.checkdocs

From the ports tree:

cd /usr/ports/textproc/py-collective.checkdocs/ && make install clean

To depend on this port in another port's Makefile:

RUN_DEPENDS=	py312-collective.checkdocs>0:textproc/py-collective.checkdocs

Packages

The version each package repository carries. “-” means the repository builds no package of it, “n/a” that there is no such repository.

Repositoryaarch64amd64armv6armv7i386
FreeBSD:14:latest0.2_10.2_10.20.2_10.2_1
FreeBSD:14:quarterly0.2_10.2_1n/a0.2_10.2_1
FreeBSD:15:latest0.2_10.2_1n/a0.2_10.2_1
FreeBSD:15:quarterly0.2_10.2_1n/an/an/a
FreeBSD:16:latest0.2_10.2_1n/an/an/a
FreeBSD:16:quarterlyn/an/an/an/an/a

Dependencies

As this port's Makefile names them.

Runtime 1

The full lists below include those, and their dependencies in turn.

Build dependencies 11
Run dependencies 8

No port depends on this one.

Configuration

No options to configure.

USES
python zip
Service scripts
none

Files

distinfo 1
FileSizeSHA256
collective.checkdocs-0.2.zip108653a5328257c5224bc72753820c182910d7fb336bc1dba5e09113d48566655e46e
Master sites 1
  • PYPI

Commit history 0

No commits in the history this site was built from.