{"categories":[{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"}],"enrichment":{"capability":"Sphinx Lint checks reStructuredText and Python documentation files for stylistic and formal issues that Sphinx itself may not catch, running as a command-line linter or pre-commit hook.","skillfed_tags":["rst-linting","pre-commit-ready","documentation-tooling"],"use_cases":["Catch reStructuredText syntax errors during local editing before running a full Sphinx build.","Enforce documentation style consistency across a project via pre-commit hooks.","Validate documentation files in CI/CD pipelines without triggering a complete Sphinx build.","Find role and directive issues that Sphinx's build process does not report.","Lint individual .rst files during authoring without checking the entire documentation tree."],"what_it_does":"Sphinx Lint is a command-line linter for reStructuredText and Python documentation files, designed to find errors that Sphinx's own build process does not catch. It evolved from CPython's rstlint.py tool and focuses on stylistic and formal issues\u2014malformed roles, unclosed directives, and similar problems\u2014while deliberately avoiding duplication of checks that sphinx-build already performs. The tool runs line-by-line and is intended to be fast enough for editor integration and single-file checking.\n\nThe linter can be invoked directly on files or directories, integrated into pre-commit workflows, and configured to ignore specific paths. It aims for zero false positives, though it currently skips some rules within tables due to limitations in line-by-line parsing. Runtime dependencies are minimal (polib and regex), and it supports Python 3.10 through 3.14.","worth_installing":"Yes. Sphinx Lint is actively maintained, has no security vulnerabilities, low install friction, and a permissive license. It fills a genuine gap\u2014catching documentation errors Sphinx misses\u2014and is designed for both local and CI use. The line-by-line limitation in tables is a known constraint, not a hidden gotcha. Suitable for any project using reStructuredText documentation."},"id":"sphinx-lint","links":{"html":"https://skillfed.io/packages/sphinx-lint","md":"https://skillfed.io/packages/sphinx-lint.md","pypi":"https://pypi.org/project/sphinx-lint/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2025-11-19","license_spdx":"PSF-2.0","license_treatment":"permissive","name":"sphinx-lint","python_support":"supports_current","summary":"Check for stylistic and formal issues in .rst and .py files included in the documentation."},"popularity":{"monthly_downloads":811563,"position":5003,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"1.0.2"}