Registry / testing / collective-checkdocs

collective-checkdocs

library0.2pypypiunverified

A distutils command to view and validate reStructuredText in a package's long_description. Current version 0.2, last released in 2012 (in maintenance mode).

testing devops

pip install collective.checkdocs

github ↗package ↗

INSTALL

IMPORT

SIG · COLLECTIVE-CHECKDO

collective-checkdocs

testingpythonv0.2

Install

2.9s avg

Import

308ms

Disk

21MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v0.2 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.198s · 23.5MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 2.9s · import 0.172s · 24MB

21MB installed

● package 21MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

checkdocs

✓ from collective.checkdocs import checkdocs

✗ from setuptools import setup

Add 'collective.checkdocs' to setup_requires and use the 'checkdocs' command to validate long_description.

# In setup.py: from setuptools import setup setup( name='mypackage', version='0.1', description='My package', long_description=open('README.rst').read(), setup_requires=['collective.checkdocs'], # ... ) # Then run: python setup.py checkdocs

checkdocs --version

Debug

Known issues

deprecatedcollective.checkdocs is unmaintained since 2012; consider using 'twine check' instead.

fix

Use 'twine check dist/*' after building your package.

affects: all

gotchaThe package is installed as a setup_requires dependency, not a regular runtime dependency. Adding it to install_requires will break deployments.

fix

Only add to setup_requires in setup.py, never to install_requires.

affects: all

gotchaPython 3 compatibility was never officially released; may fail on Python 3.6+.

fix

Use 'twine check' or 'rstcheck' for modern Python versions.

affects: all

Upgrade

Version history

0.2latest on PyPI · released Jun 6, 2014

Audit

Dependencies

setuptoolsrequiredrequired for setup.py command

docutilsrequiredrequired for reST parsing

Pygmentsoptionalsyntax highlighting in rendered output

Agent activity

7 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/collective/collective.checkdocs ↗

packagehttps://pypi.org/project/collective-checkdocs/ ↗