jCloud/jcloud-docsgen

1 Fork 0

generated from jCloud/repository-template

T

jakob.scheid 5791358b41

feat(python-generator): add force argument to generator

Added a force argument to
PythonDocumentationGenerator.generate_documentation to control whether
the content of the output directory should be overwritten or not, if it
is not empty. If the force argument is True, the output directory
content will first be deleted recursively. If it is False and the output
directory is not empty, a DirectoryNotEmptyError will be raised.

2026-09-27 14:59:28 +02:00

.gitea/workflows

chore(ci): add workflow to generate API reference

2026-09-22 13:15:47 +02:00

docs(changelog): add project directory structure entry

2026-09-22 19:28:34 +02:00

style: ensure trailing newlines

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

chore: add setup script

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

src/jcloud_docsgen

feat(python-generator): add force argument to generator

2026-09-27 14:59:28 +02:00

test(python-generator): update tests to do not assume src/ directories

2026-09-22 19:26:55 +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

docs(readme): update installation instructions

2026-09-22 12:37:10 +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 the package jcloud-docsgen from the Gitea Package Registry.

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.