Python docs, made simple

AI-powered documentation with summaries, code explanations, semantic search, and more.

pip install pydocenhancer

Features

Everything you need for next-level Python documentation

Auto-Generated Summaries

Summarize modules, classes, and functions with concise, AI-generated overviews.

Code Explanations

Plain-English explanations of code logic for better understanding and onboarding.

Semantic Search

Query documentation with natural language (e.g., 'find data processing functions').

Auto-Generated Examples

Create working code examples from docstrings automatically.

Automated Example Testing

Extracts and runs code examples from docstrings, reporting results in the docs.

Multilingual Documentation

Generate documentation in multiple languages (English, French, Spanish, Chinese) using LLM translation.

Local LLM Support

Privacy-first processing with local models (e.g., LLaMA 3.2, ctransformers backend).

Integrations

Works with Sphinx, MkDocs, and Jupyter Notebooks for seamless documentation workflows.

README Generation

Automatically generate a project-level README summarizing your module, classes, and functions.

Requirements

Python 3.8+
Compatible with modern Python versions
Local LLM
e.g., LLaMA 3.2 via ctransformers backend
Optional: Sphinx or MkDocs
For documentation integration

Quick Start

Get up and running in minutes

PyDocEnhancer Quick Start
1 of 3

Install (Recommended)

Install PyDocEnhancer with local LLM support (no C++ build tools required)

pip install pydocenhancer[local]
bash

Use Cases

Trusted by developers worldwide

Open Source Projects

Maintain consistent, professional documentation across releases. Generate comprehensive API references automatically.

Development Teams

Standardize documentation practices across your team. Integrate seamlessly with existing workflows.

Data Scientists

Document complex algorithms and data processing pipelines with clear, accessible explanations.

Independent Developers

Create professional documentation without overhead. Focus on building while maintaining quality docs.