Never write another *.md file for Python again!
Let your docstrings do the work while this tool handles the documentation.
✨ Set It and Forget It - Initialize once and your help files stay magically updated
🔍 Smart Difference Checking - Only updates what's changed (no more pointless rewrites)
📚 Comprehensive Documentation - Extracts everything from docstrings to type hints
🧭 Built-in Navigation - Automatic table of contents with quick links to all sections
⚡ Usage Examples - Generates sample code snippets showing how to call each function
🎯 Exclusion Support - Skip private/internal methods with a simple JSON config
Just drop this script in your project! No dependencies needed (except Python 3.6+).
from help_gen import HelpFileGen
# For a single script
help_gen = HelpFileGen("your_script.py")
# For a package (will process all __init__.py files)
help_gen = HelpFileGen("your_package/")That's it! Your your-script-help.md file will be automatically created/updated.
HelpFileGen(
module_path="your_module.py",
output_file="CUSTOM_NAME.md", # Default: "help.md"
overwrite=False, # Default: True (safe mode)
include_args=True # Show arguments in separate section
)- AST Walking - Parses your Python files without executing them
- Docstring Extraction - Pulls help text from all your carefully written docstrings
- Signature Analysis - Shows argument types, defaults, and kwarg details
- Checksum Comparison - Only updates what's changed since last run
- Markdown Generation - Creates beautiful, navigable documentation
# Table of Contents
[Classes] | [Functions]
## Class: `MyAwesomeClass`
[Method 1] | [Method 2] | [Method 3]
### Method: `do_something`
#### Arguments:
- param1: str = "default"
- param2: int
#### Help:
> This method does something amazing with the parameters...
#### Usage:
```python
obj = MyAwesomeClass()
obj.do_something(
"custom_value",
42
)
[Back to MyAwesomeClass] | [Back to Top]- Exclusion List - Add private methods to
.jsondata/exclude_help_ast.json - Checksum Tracking - Stored in
.jsondata/*.checksums.jsonfor smart updates - Type Hint Love - The more type hints you add, the better your docs will be!
🌐 Multi-language Support (JavaScript, Ruby, and more on the roadmap)
🔗 Cross-reference Linking between related functions
📊 Visualization Generation for complex class hierarchies
Why waste time writing documentation that goes stale immediately? Let your code document itself - the way it should be!
Never write another *.md file for Python again! 🎉