{"categories":[{"label":"Utilities","url":"https://skillfed.io/packages/category/utilities/4"},{"label":"Systems Administration","url":"https://skillfed.io/packages/category/system-systems-administration"}],"enrichment":{"capability":"doc8 is a style checker for reStructuredText documentation that validates formatting rules like line length, trailing whitespace, indentation, and newline conventions.","skillfed_tags":["documentation-linting","rst-validation","ci-cd-tool"],"use_cases":["Enforce consistent RST formatting in Sphinx-based documentation projects as part of CI/CD pipelines.","Validate documentation style in multi-contributor projects to catch formatting issues before merge.","Check documentation compliance in automated quality gates alongside code linting tools.","Scan existing documentation repositories for style violations and generate reports for remediation.","Programmatically validate RST files in documentation generation workflows."],"what_it_does":"doc8 is a command-line and programmatic style checker for reStructuredText documentation. It enforces a set of opinionated formatting rules including line length limits (default 79 characters), trailing whitespace removal, proper indentation without tabs, Unix newlines, and valid RST syntax. The tool can be run directly against documentation directories or integrated into Python projects via its API.\n\nThe package depends on docutils for RST parsing, restructuredtext-lint for linting checks, stevedore for plugin management, tomli for TOML configuration parsing, and Pygments for syntax highlighting. It supports configuration via command-line arguments or INI-style files (doc8.ini, setup.cfg, tox.ini, pyproject.toml) and allows selective error ignoring and path exclusion. Results are returned as structured error tuples or human-readable reports.","worth_installing":"Yes. doc8 is actively maintained, has no known vulnerabilities, installs with low friction, and is widely used (top 5000 PyPI packages). It fills a clear niche in RST documentation quality assurance. Install it if you maintain Sphinx or reStructuredText documentation and want automated style enforcement."},"id":"doc8","links":{"html":"https://skillfed.io/packages/doc8","md":"https://skillfed.io/packages/doc8.md","pypi":"https://pypi.org/project/doc8/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2025-06-13","license_spdx":"Apache-2.0","license_treatment":"permissive","name":"doc8","python_support":"supports_current","summary":"Style checker for Sphinx (or other) RST documentation"},"popularity":{"monthly_downloads":902421,"position":4770,"tier":"top_5000"},"security":{"n_vulnerabilities":0},"version":"2.0.0"}