H a p d o c

autodoc CLI tool written in Python with ❤️

Why Hapdoc? 💁‍♀️

• Easy to use: Hapdoc is designed to be simple and user-friendly, making it easy for programmers to create documentation without having to spend a lot of time learning how to use it.
• Markdown support: Hapdoc supports Markdown syntax, which is a popular markup language used by many developers. This means that programmers can write documentation using the same tools they use to write code, making the process more familiar and efficient.
• Customizable themes: Hapdoc supports different themes, allowing programmers to choose a look and feel that matches their project or organization's branding. Additionally, programmers can create their own themes if they want to customize the look of their documentation further.

Features ✨

• Supported projects:
  • Python
  • FastAPI
  • JavaScript
• Generate Markdown docs via gen command.
• Build docs into HTML via build command.
• Build Markdown docs into JSON via md2json command.
• Serve generated docs at your server via serve command.
• Create your own templates via tmpl-new.
• See your saved templates via tmpl-list.
• Prepare your docs with project.hapdoc config file.

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 💫

You can help us and create PR with project type ✌