{"categories":[{"label":"Python Modules","url":"https://skillfed.io/packages/category/software-development-libraries-python-modules/15"},{"label":"Quality Assurance","url":"https://skillfed.io/packages/category/software-development-quality-assurance/3"}],"enrichment":{"capability":"A flake8 plugin that validates Python docstrings as reStructuredText markup, catching RST syntax errors and formatting issues in docstring content.","skillfed_tags":["docstring-linting","rst-validation","flake8-plugin"],"use_cases":["Enforce consistent reStructuredText formatting in docstrings across a project during CI/CD linting.","Catch RST syntax errors (malformed tables, unclosed markup, undefined substitutions) before documentation generation.","Validate docstrings in Sphinx-documented projects by configuring recognized directives and roles.","Combine with flake8-docstrings to check both docstring presence (PEP 257) and RST markup validity.","Detect inline markup errors like mismatched emphasis or literal block issues in docstring content."],"what_it_does":"This is a flake8 plugin that integrates reStructuredText validation into your code linting workflow. It parses docstrings in Python files and checks them for RST markup errors using the docutils library, reporting issues with codes like RST201\u2013RST220 for warnings, RST301\u2013RST308 for major errors, and RST401\u2013RST499 for severe errors. It complements pydocstyle-based checks (which validate docstring presence and PEP 257 conventions) by focusing specifically on the markup quality of docstring content.\n\nThe plugin runs as part of flake8, automatically detecting RST violations and reporting them with line numbers. It maps docutils severity levels to flake8 codes, so you can selectively enable or ignore specific RST error categories. Configuration options let you register custom Sphinx directives and roles to avoid false positives in projects using Sphinx extensions.","worth_installing":"Yes. The plugin is actively maintained, has no known vulnerabilities, installs with low friction, and fills a specific gap: validating RST markup in docstrings. Install it if your project uses reStructuredText docstrings and you want to catch markup errors early. Pair it with flake8-docstrings for comprehensive docstring linting."},"id":"flake8-rst-docstrings","links":{"html":"https://skillfed.io/packages/flake8-rst-docstrings","md":"https://skillfed.io/packages/flake8-rst-docstrings.md","pypi":"https://pypi.org/project/flake8-rst-docstrings/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2025-10-06","license_spdx":null,"license_treatment":"permissive","name":"flake8-rst-docstrings","python_support":"supports_current","summary":"Python docstring reStructuredText (RST) validator for flake8"},"popularity":{"monthly_downloads":226773,"position":9196,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.4.0"}
