astdoc

A lightweight Python library for parsing AST and extracting docstring information. Automatically generate documentation from Python source code by analyzing abstract syntax trees and docstrings.

Source

PyPI

Version: 1.3.2

Maintainers: 1

astdoc

A lightweight Python library for parsing and analyzing abstract syntax trees (AST) and extracting docstring information. Designed to facilitate the documentation process, astdoc provides tools for developers to easily access, manipulate, and generate documentation from Python code.

Features

Smart Docstring Parsing: Automatically extracts and parses docstrings in Google and NumPy styles
AST Analysis: Deep understanding of Python code structure through AST traversal
Namespace Support: Handles namespace packages and complex module structures
Type-Aware: Built-in support for type hints and annotations
Modern Python: Compatible with Python 3.10+ including the latest 3.13
Lightweight: Minimal dependencies, focusing on core functionality

Installation

pip install astdoc

Documentation

For detailed documentation, visit https://daizutabi.github.io/astdoc/

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Keywords

documentation-generator

FAQs

What is astdoc?

Is astdoc well maintained?

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install