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 :sparkles:
- Supported projects:
PythonFastAPIJavaScript
- Generate Markdown docs via
gencommand. - Build docs into HTML via
buildcommand. - Build Markdown docs into JSON via
md2jsoncommand. - Serve generated docs at your server via
servecommand. - Create your own templates via
tmpl-new. - See your saved templates via
tmpl-list. - Prepare your docs with
project.hapdocconfig 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 :dizzy:
You can help us and create PR with project type ✌
1 maintainer
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.9.25.tar.gz
(20.7 kB
view details)
File details
Details for the file hapdoc-1.9.25.tar.gz.
File metadata
- Download URL: hapdoc-1.9.25.tar.gz
- Upload date:
- Size: 20.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/4.0.1 CPython/3.10.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5fb1b4198d9eebd7ebeba861594bd2161a2586f7b32cfc3c9ef426d200fa116c
|
|
| MD5 |
ceddf306fb7c811eddb8fdd7f53b673a
|
|
| BLAKE2b-256 |
31316c65edf754e61b87cae18ea0f764ed9990b7ea428051e5c01942f3094bed
|
