hapdoc 1.4.1

autodoc tool for everything

H a p d o c

autodoc CLI tool written in Python with :heart:

Why Hapdoc? :information_desk_person:

Because it's simple to use.

Features :sparkles:

• Supported projects:
  • Python
  • FastAPI
• Generate markdown docs, Serve it via FastAPI or Build docs into HTML files.

Installing :inbox_tray:

via pypi 📦

pip install hapdoc --upgrade

via git 💾

pip install https://github.com/hapticx/hapdoc

Usage :zap:

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

What's Next? :bulb:

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 :v: