generated from jCloud/repository-template
22 lines
546 B
Markdown
22 lines
546 B
Markdown
# jcloud-docsgen
|
|
|
|
A tool that generates Markdown documentation from software project source code.
|
|
|
|
Currently supported programming languages:
|
|
- Python
|
|
|
|
## Installation
|
|
|
|
You can install it using pip:
|
|
|
|
```bash
|
|
pip install jcloud-docsgen --index-url https://repo.jcloud-services.ddns.net/simple/ --extra-index-url https://pypi.org/simple/
|
|
```
|
|
|
|
## Reference
|
|
|
|
API reference and generated documentation can be found in [docs/reference](docs/reference).
|
|
|
|
## Notice
|
|
|
|
This project is under active development. The documentation will be expanded over time. |