generated from jCloud/repository-template
jakob.scheid
25a92d710e
Added a setup script in scripts/ to configure Git to use the commit message template and added a reference to it to README.md.
638 B
638 B
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:
pip install jcloud-docsgen --index-url https://repo.jcloud-services.ddns.net/simple/ --extra-index-url https://pypi.org/simple/
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.
Notice
This project is under active development. The documentation will be expanded over time.