# 🙌 Handsdown - Python documentation generator
Project description
🙌 Handsdown - Python documentation generator
Python docstring-based documentation generator for lazy perfectionists.
🔬 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 links easily as
handsdown.generator.Generator.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
# output buolt MD files to docs/*
handsdown
# or provide custom output: output_dir/*
handsdown -o output_dir
# generate docs only for my_module, but no migrations, plz
handsdown my_module --exclude my_module/migrations
Navigate to docs/index.md
to check your new documentation!
🧩 As a module
from handsdown import Generator
from handsdown import PathFinder
repo_path = Path.cwd()
handsdown = Generator(
input_path=repo_path,
output_path=repo_path / 'output',
source_paths=PathFinder(repo_path, "**/*.py").list()
)
# generate all docs at once
handsdown.generate_docs()
# or generate just for one doc
handsdown.generate_doc(repo_path / 'my_module' / 'source.py')
# and generate index.md file
handsdown.generate_index()
🐶 Installation
Install using pip
pip install handsdown
🔧 Development
- Install pipenv
- Run
pipenv install -d
- Use
black
formatter in your IDE
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.2.tar.gz
(18.3 kB
view hashes)
Built Distribution
handsdown-0.1.2-py3-none-any.whl
(28.7 kB
view hashes)
Close
Hashes for handsdown-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 87a170a6f61121c05eb52ea88a2e1f027b70e6f4dec402be8cc61c6bee0a793b |
|
MD5 | b039e172c1dda1718d93a687597c706c |
|
BLAKE2b-256 | cc368823e8985798087ef4ed26b566973e4ba65060c443b4173f4ae108cab2be |