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
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file astdoc-1.1.7.tar.gz.
File metadata
- Download URL: astdoc-1.1.7.tar.gz
- Upload date:
- Size: 60.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.6.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e8efeb2a707f6c7dbb5da67857a359b4bb5172ce2914c698a80947c3403322f0
|
|
| MD5 |
79dfbd0475f0dbacb15ebab386a58965
|
|
| BLAKE2b-256 |
ed2328d7d83cddc962c5f2563e916c0fd80a6cec528106fd4de14a57ab8034a4
|
File details
Details for the file astdoc-1.1.7-py3-none-any.whl.
File metadata
- Download URL: astdoc-1.1.7-py3-none-any.whl
- Upload date:
- Size: 43.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.6.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
14ca0fdd2c9ead9e00371ccf6d0d4e86652ebbbd83c463c3841752c2082eb036
|
|
| MD5 |
a20069166ac1888a46c2c52c9842e636
|
|
| BLAKE2b-256 |
8b790d1a485a6efa0af6ab95a8440a2e8556c2e4420b2017931c3f6b2512623d
|