docutils-stubs

What it is and what it does

docutils-stubs is a type stub package that adds PEP 561 compliant type information to the docutils library. When installed alongside docutils, it allows static type checkers like mypy and IDEs to understand the types and signatures of docutils functions and classes, enabling better autocompletion, inline documentation, and type-checking errors during development.

The package is a thin wrapper—it contains only type definitions, not runtime code. It depends on docutils itself and is intended to be used as a development dependency. However, the project has been abandoned since early 2022, meaning no updates have been made to reflect changes in docutils or to fix any type stub issues discovered after that date.

Use it for:

• Enable mypy or other type checkers to validate code that uses docutils without type errors
• Improve IDE autocomplete and inline help when writing docutils-based document processing scripts
• Support type-aware refactoring in editors for projects that manipulate reStructuredText or other docutils formats

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides PEP 561 type stubs for docutils, enabling type checking and IDE autocompletion when working with the docutils library.

Yes, if you need type checking for docutils and are using a version released before early 2022. No, if you require active maintenance or are using recent docutils versions—the package is abandoned and may have incomplete or outdated type coverage. Consider checking whether docutils itself now includes inline type hints before installing this stub package.

Install

docutils-stubs on PyPI

pip install docutils-stubs

uv add docutils-stubs

poetry add docutils-stubs

Installing docutils-stubs

Before you install

Low friction to install as a pure-Python wheel. However, the package is abandoned—last release was 2022-01-02, over 1685 days ago. No active maintenance or updates.

License in practice

Licensed under the Unlicense (permissive), placing the package in the public domain with minimal restrictions on use or modification.

Quickstart

pip install docutils-stubs

import docutils.core
# Type checker now understands docutils APIs

Requires docutils to be installed separately; stubs alone do not provide runtime functionality.

Verify before relying

• Whether type stub coverage is complete for all docutils APIs or only a subset
• Compatibility with recent docutils versions released after 2022-01-02
• Whether the stubs work with current type checkers (mypy, pyright, etc.)

Package facts

Evidence: docutils_stubs-0.0.22-py3-none-any.whl

Tags

More Documentation packages