{"categories":[{"label":"Python Modules","url":"https://skillfed.io/packages/category/software-development-libraries-python-modules/22"}],"enrichment":{"capability":"Adds distutils commands to validate and preview reStructuredText in a Python package's long_description field before publishing to PyPI.","skillfed_tags":["legacy","distutils-deprecated"],"use_cases":["Validate reStructuredText syntax in a package's long_description before uploading to PyPI to catch formatting errors early.","Preview how your package's README will render as HTML on PyPI without actually publishing it.","Integrate documentation validation into a legacy distutils-based build pipeline that has not migrated to modern tools."],"what_it_does":"collective.checkdocs is a distutils plugin that adds two commands to your setup.py: checkdocs validates your package's long_description field as reStructuredText and reports syntax errors before publishing, while showdocs renders the description as HTML and serves it locally in a web browser for preview. It was designed to catch formatting errors early and avoid broken package pages on PyPI.\n\nThe package has been abandoned since its last release on 2014-06-06 and is not maintained for modern Python or packaging ecosystems. It relies on distutils, which is deprecated. No runtime dependencies are listed, but the high install friction and lack of updates make it a poor fit for contemporary development workflows.","worth_installing":"No. This package is abandoned (last release 2014-06-06) and built on deprecated distutils. Modern alternatives using contemporary build tools are far more reliable and actively maintained. The GPL copyleft license also adds friction for proprietary projects. Install only if you are maintaining legacy code that already depends on it."},"id":"collective-checkdocs","links":{"html":"https://skillfed.io/packages/collective-checkdocs","md":"https://skillfed.io/packages/collective-checkdocs.md","pypi":"https://pypi.org/project/collective-checkdocs/"},"maintenance":{"status":"abandoned"},"meta":{"latest_release":"2014-06-06","license_spdx":null,"license_treatment":"copyleft","name":"collective.checkdocs","python_support":"unspecified","summary":"Distutils command to view and validate restructured text in package's long_description"},"popularity":{"monthly_downloads":79588,"position":14348,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.2"}
