autodoc tool for everything
Project description
Why Hapdoc? 💁♀️
Because it's simple to use. 🙂
Features :sparkles:
- Supported projects:
Python
FastAPI
- Generate Markdown docs via
gen
command. - Build docs into HTML via
build
command. - Serve generated docs at your server via
serve
command. - Create your own templates via
tmpl-new
command.
Installing 📥
via pypi
📦
pip install hapdoc --upgrade
via git
💾
pip install https://github.com/hapticx/hapdoc
Usage ⚡
Help message
hapdoc --help
Generate and serve docs via FastAPI:
hapdoc gen path/to/project
hapdoc serve docs/hapdoc -h 127.0.0.1 -p 5000
Build HTML docs:
hapdoc build path/to/project
What's Next? 💡
We planned to add some other project types! Check more in issues:doc_rules
Contributing :dizzy:
You can help us and create PR with project type ✌
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
hapdoc-1.6.0.tar.gz
(16.4 kB
view hashes)