1 Fork 0

generated from jCloud/repository-template

T

Added a setup script in scripts/ to configure Git to use the commit
message template and added a reference to it to README.md.

2026-09-21 22:27:28 +02:00

.gitea/workflows

hotfix(cd): fix job label

2026-09-03 19:42:05 +02:00

docs

docs(changelog): update CLI entry

2026-09-13 19:04:53 +02:00

licenses

style: ensure trailing newlines

2026-09-01 16:54:03 +02:00

scripts

chore: add setup script

2026-09-21 22:27:28 +02:00

src/jcloud_docsgen

chore: lint source code using Ruff

2026-09-21 20:10:09 +02:00

tests

refactor(python-generator): rename misnamed testing function

2026-09-21 22:12:00 +02:00

.gitignore

chore: add VS Code directory to gitignore

2026-09-05 13:47:11 +02:00

.gitmessage

chore: add commit message template

2026-09-21 22:21:40 +02:00

LICENSE

Update licenses

2026-04-30 19:28:53 +02:00

NOTICE

Add license for pytest-expectdir

2026-04-27 22:13:22 +02:00

poetry.lock

chore(deps): add Ruff dependency

2026-09-18 22:31:09 +02:00

pyproject.toml

chore(ruff): add Ruff configuration

2026-09-18 22:40:39 +02:00

README.md

chore: add setup script

2026-09-21 22:27:28 +02:00

README.md

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.