Skip to main content

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.

Project description

astdoc

PyPI Version Build Status Coverage Status Documentation Status Python Version

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

astdoc-1.3.0.tar.gz (61.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

astdoc-1.3.0-py3-none-any.whl (43.6 kB view details)

Uploaded Python 3

File details

Details for the file astdoc-1.3.0.tar.gz.

File metadata

  • Download URL: astdoc-1.3.0.tar.gz
  • Upload date:
  • Size: 61.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.16

File hashes

Hashes for astdoc-1.3.0.tar.gz
Algorithm Hash digest
SHA256 d00f27ef811beed4d7e102a31aac69e5b7fb0b31719d7bd5dc1162b3f1c99a25
MD5 b556a0fcc19c6707aadc986e760a9326
BLAKE2b-256 ece5511e6a825442763ac5af6522849afa0556e9391babbd8eb536fc2a378319

See more details on using hashes here.

File details

Details for the file astdoc-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: astdoc-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 43.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.16

File hashes

Hashes for astdoc-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 446a9fa960340b99d44e2413f3ca2d991a1a9b8c2c9df8ac37c1ac98153f5bb4
MD5 efd2df80cc2adfe12d23a9c7be6a4f33
BLAKE2b-256 0e5119286f94f0e18c4b02653b7ea548a7d158baad7e447fee8fc4cb4ccaa40a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page