# 🙌 Handsdown - Python documentation generator
Project description
🙌 Handsdown - Python documentation generator
Python docstring-based documentation generator for lazy people.
🔬 Features
- 👓 PEP257, Google and RST docstrings support. All of them are converted to a valid markdown.
- 🐈 Github-friendly. Use your local markdown viewer or open docs right on Github
- 📚 Signatures for every class, function and method.
- 🚀 Support for type annotations. Even for the ones from the
__future__
! - 📦 Nice list of all modules in Modules
- 🔎 Gather all scattered
README.md
in submodules to one place - 🚧 Links to source code from every doc section.
- #️⃣ Create cross-references easily
handsdown.handsdown.Handsdown.replace_links
(check index.md) - 💕 Do you love type annotations? Well, you get auto-discovery of related modules for free!
🎉 Usage
💻 From command line
Just go to your favorite project that has lots of docstrings but missing auto-generated docs and let handsdown
do the thing.
cd ~/my/project
handsdown -o docs
Navigate to docs/index.md
to check your new documentation!
🧩 As a module
from handsdown.handsdown import Handsdown
handsdown = Handsdown(
input_path=Path('path/to/my/repo'),
output_path=Path('path/to/output'),
)
# generate all docs at once
handsdown.generate()
# or generate one doc
output_file_path = handsdown.generate_doc(Path('path/to/my/repo/source.py'))
output_file_path # Path('path/to/output/source.md')
🔧 Installation
Install using pip
pip install handsdown
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
handsdown-0.1.1.tar.gz
(13.0 kB
view hashes)
Built Distribution
handsdown-0.1.1-py3-none-any.whl
(16.9 kB
view hashes)
Close
Hashes for handsdown-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9250ecd7b20a513007698c0a7385ec3d522a6242ae375665e9951cc7117f1cb5 |
|
MD5 | 6ba3e443406e8588098d733923721bae |
|
BLAKE2b-256 | dd6dd89bc4e303ef4b26e7d467e2c389aee9cd728abb3e286442ff3a7bd46017 |