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.2.tar.gz (39.7 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.2-py3-none-any.whl (43.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for astdoc-1.3.2.tar.gz
Algorithm Hash digest
SHA256 adcc6a5cecdbd23ea25b095bd3ebb183c2c73fae03499c3d8e0ae932d73e8bb2
MD5 586a4581eb7a65e0eaf161684a481e7e
BLAKE2b-256 ff3059731db1342957b1d035b16c515c75aeb0b3111159838e58e7a68256745a

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for astdoc-1.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 68d4c19fbb9e78d9acde21806d9688ec403c9a5a87f09ec4695d8ad607df2056
MD5 f33aecda34d419eba280bbbf9e987f77
BLAKE2b-256 4ec2b90bfe4fd68d5baf2ea7514f62bfd0c8ad20820a433d696a0dd49b13f08a

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