flake8-rst-docstrings
Python docstring reStructuredText (RST) validator for flake8
Decision gist · record as of 2026-08-14
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.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.9 or later.
- Low friction installation with three runtime dependencies (flake8, restructuredtext_lint, pygments).
- Actively maintained with a recent release in October 2025 and ongoing commits through August 2026.
License · maintenance · safety
MIT (permissive) — MIT licensed, permissive terms—you can use, modify, and distribute the package freely in commercial and private projects without restriction.
last release 2025-10-06 (312 days) · last repo commit 2026-08-03 · 58 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 226,773 downloads/mo, #9,196 on PyPI
Alternatives
Verify before relying
pip install flake8-rst-docstrings
flake8 example.py
# or to see only RST violations:
flake8 --select RST example.py- Whether false positives are common when using Sphinx extensions without explicit configuration.
- Performance impact on large codebases with many docstrings.
What it is and 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–RST220 for warnings, RST301–RST308 for major errors, and RST401–RST499 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.
The 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.
Use it for
- 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.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
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.
Install
flake8-rst-docstrings on PyPI
Before you install
Low friction installation with three runtime dependencies (flake8, restructuredtext_lint, pygments). Actively maintained with a recent release in October 2025 and ongoing commits through August 2026.
Requires Python 3.9 or later.
License in practice
MIT licensed, permissive terms—you can use, modify, and distribute the package freely in commercial and private projects without restriction.
Quickstart
pip install flake8-rst-docstrings
flake8 example.py
# or to see only RST violations:
flake8 --select RST example.pyVerify before relying
- Whether false positives are common when using Sphinx extensions without explicit configuration.
- Performance impact on large codebases with many docstrings.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.9 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 3 packagesflake8restructuredtext_lintpygments |
| Maintenance | Actively maintained 312 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 226,773 / month, #9,196 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 4 - BetaFramework :: Flake8Intended Audience :: DevelopersLicense :: OSI Approved :: MIT LicenseOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyTopic :: Software Development :: Libraries :: Python ModulesTopic :: Software Development :: Quality Assurance |
Evidence: flake8_rst_docstrings-0.4.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “flake8 docstring validation”
- flake8-rst-docstringsA flake8 plugin that validates Python docstrings as reStructuredText…
- flake8-docstringsIntegrates pydocstyle docstring checking into flake8, allowing you to…
- flake8-literalA flake8 plugin that enforces consistent styling of string literals,…
Give your agent the search over MCP, or paste the wish link into any chat.
More Python Modules packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
PyYAML parses and emits YAML 1.1 data format, enabling serialization and deserialization of configuration files and Python objects to and from human-readable YAML text.
Pydantic validates Python data structures against type hints, coercing and checking input at runtime to ensure it matches a declared schema.
Provides reusable metadata objects for use with PEP-593 `typing.Annotated` to express common constraints like bounds, collection sizes, and predicates on types.
Install it if you use or build libraries that need to express type constraints in a standardized, inspectable way—or if you want to annotate your own types with…
Provides runtime tools to inspect and introspect Python type annotations, enabling programmatic examination of type hints at execution time.
See also restructuredtext-lint · collective.checkdocs · flake8-docstrings · docstrfmt · sphinx-lint · rstcheck · rstcheck-core · pydoclint · docsig · flake8-isort