generated from jCloud/repository-template
jakob.scheid
14d6a8984a
Previously, there were instructions how to install the package (over the old registry) in README.md. They were replaced with a reference to the Gitea Package Registry.
23 lines
626 B
Markdown
23 lines
626 B
Markdown
# jcloud-docsgen
|
|
|
|
A tool that generates Markdown documentation from software project source code.
|
|
|
|
Currently supported programming languages:
|
|
- Python
|
|
|
|
## Installation
|
|
|
|
You can install the package `jcloud-docsgen` from the [Gitea Package Registry](https://gitea.jcloud-services.ddns.net/jCloud/-/packages/pypi/jcloud-docsgen/).
|
|
|
|
## Setup
|
|
|
|
Please execute `scripts/setup.sh` when cloning the repository to configure Git.
|
|
|
|
## 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.
|