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.1.8.tar.gz (61.0 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.1.8-py3-none-any.whl (43.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for astdoc-1.1.8.tar.gz
Algorithm Hash digest
SHA256 289c247997787e6a06770b27e02c8e1313aa54637a92752f63797aa0a673e7ce
MD5 a5f735a2cf8b46f6bb5c179688d0ada1
BLAKE2b-256 2bd4eda1e2cdd11c4e2d068423a08b5af1436aab886755dc1765d117736f1ac6

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for astdoc-1.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 15c459e3bb82620a5a1f2aa9f4973db57e8a0fba7335801fa1c05b7d3f03b18b
MD5 f4cfcc550f1a991c05b5d9d6efa5f728
BLAKE2b-256 d41148b6311ec4dacfd6e651628b588fbd939b70b238bf89943619ec42e23443

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