Metadata-Version: 2.1
Name: hapdoc
Version: 0.5
Summary: autodoc tool for everything
Home-page: https://github.com/HapticX/hapdoc
Author: Ethosa
Author-email: social.ethosa@gmail.com
Maintainer: HapticX
Maintainer-email: hapticx.company@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Framework :: FastAPI
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
License-File: LICENSE

<div align="center">

## `h a p d o c`
autodoc CLI tool written in Python

![Python](https://img.shields.io/badge/Python%203.10-35497E?style=for-the-badge&logo=python&logoColor=FFF077)
![FastAPI](https://img.shields.io/badge/FastAPI-35497E?style=for-the-badge&logo=fastapi&logoColor=FFF077)
![Version](https://img.shields.io/badge/Hapdoc%200.3-35497E?style=for-the-badge&logo=pypi&logoColor=FFF077)

</div>

## Install
via `git`
```bash
pip install https://github.com/hapticx/hapdoc
```

## Usage
Generate and serve docs via FastAPI:
```bash
hapdoc gen path/to/project
hapdoc serve -d docs/hapdoc -h 127.0.0.1 -p 5000
```


