1 Fork 0

generated from jCloud/repository-template

T

The CLI now handles error that may result from user input and prints an
error message. Following error types are handled:
 - file not found
 - not a directory
 - directory instead of file
 - file exists
 - permission error
 - general operating system errors
 - Unicode errors
 - errors parsing project source code

Additionally, KeyboardInterrupt and BrokenPipeError are catched and an
appropriate exit code is returned.

2026-09-10 13:36:03 +02:00

.gitea/workflows

hotfix(cd): fix job label

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

docs

docs(changelog): add CLI entry to changelog

2026-09-10 09:51:55 +02:00

licenses

style: ensure trailing newlines

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

src/jcloud_docsgen

feat(cli): add error handling

2026-09-10 13:36:03 +02:00

tests

refactor: remove or update all instances of ExistingFile and ExistingDirectory in tests

2026-09-05 14:29:31 +02:00

.gitignore

chore: add VS Code directory to gitignore

2026-09-05 13:47:11 +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 used development dependencies

2026-09-04 19:54:46 +02:00

pyproject.toml

chore: add project script

2026-09-10 09:50:19 +02:00

README.md

style: ensure trailing newlines

2026-09-01 16:54:03 +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/

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.