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.2.0.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.2.0-py3-none-any.whl (43.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for astdoc-1.2.0.tar.gz
Algorithm Hash digest
SHA256 b29f7d3de56eb99d4bb51704365b6302c79bf6d12bcb43f6d4cb7d89719c4f1b
MD5 a62be1e66f0e17b296e47185037d8365
BLAKE2b-256 b57a6dca71117ee87ff129768c6c834945a7d5f3555ae32c61dfb7f70b5f1bf0

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for astdoc-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d3fb2afc200046bf33eb85a6af5416fc0b3a134a48e158566d24eb7280a0c524
MD5 095a88d0b2996723460677acdf1f72a9
BLAKE2b-256 785e60b16702f1b5ef0a60772029c8149657d61a2599bb22077b8fd118b633c2

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