Python Docstring Extractor

---
name: "Python Docstring Extractor"
slug: "python-docstring-extractor"
description: "Extracts and indexes Python module documentation using ast.parse and docstring_parser library. Supports Google, NumPy, and Sphinx docstring formats with type hint cross-referencing via typing_inspect."
github_stars: 266
verification: "security_reviewed"
source: "https://github.com/rr-/docstring_parser"
author: "rr-"
category: "Library & API Reference"
framework: "Claude Agents"
tool_ecosystem:
  github_repo: "rr-/docstring_parser"
  github_stars: 266
---

# Python Docstring Extractor

Extracts and indexes Python module documentation using ast.parse and docstring_parser library. Supports Google, NumPy, and Sphinx docstring formats with type hint cross-referencing via typing_inspect.

## Installation

Use the upstream install or setup path that matches your environment:
- pip install docstring_parser
- python -m pip install docstring_parser
- git clone https://github.com/rr-/docstring_parser.git
- pip install -e ".[dev]" # install as editable

Requirements and caveats from upstream:
- Parse Python docstrings. Currently support ReST, Google, Numpydoc-style and
- python
- python -m venv venv # create environment

Basic usage or getting-started notes:
- Example usage:
- shell
- # or if you want to install it in a virtual environment

- Source: https://github.com/rr-/docstring_parser
- Extracted from upstream docs: https://raw.githubusercontent.com/rr-/docstring_parser/HEAD/README.md

## Source

- [Agent Skill Exchange](https://agentskillexchange.com/skills/python-docstring-extractor/)