jCloud/jcloud-docsgen
2
1 Fork 0
generated from jCloud/repository-template
Code Issues 3 Pull Requests Actions Packages Projects 1 Releases 13 Wiki Activity
205 Commits 1 Branch 13 Tags
10328e660834f85e0966a168e0b72ab845439302
Commit Graph
205 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
jakob.scheid 10328e6608 refactor(exceptions): define module exports 
Added an __all__ variable to the exceptions module.
 2026-10-03 18:42:56 +02:00
jakob.scheid bc802f7b38 refactor(utils): define module exports 
Added an __all__ variable to the utility module.
 2026-10-03 18:40:22 +02:00
jakob.scheid 6b19690dc9 Merge pull request 'Fix(python-generator): prevent from namespace name conflicts' (#58) from fix/python-namespace-name-conflict into main
Generate API reference / generate (push) Successful in 21s
Details 
Reviewed-on: #58
 2026-09-29 18:18:14 +02:00
jakob.scheid 7d20d21f3d docs(changelog): add Python namespace conflict fix entry 
Added a changelog entry for the Python namespace name conflict fix.
 2026-09-29 18:17:15 +02:00
jakob.scheid fe40b672da test(python-generator): add test data for namespace conflict preventing 
Added a package with the same name as a module to a test Python project.
 2026-09-29 18:13:28 +02:00
jakob.scheid 908e299fa0 fix(python-generator): check for module namespace 
Added a check whether a module namespace with the name off a directory
already exists before adding a package namespace for the directory.
 2026-09-29 18:02:15 +02:00
jakob.scheid 7e03199615 Merge pull request 'Chore: remove unnecessary third-party licenses' (#57) from chore/remove-licensing-overhead into main
Generate API reference / generate (push) Successful in 23s
Details 
Reviewed-on: #57
 2026-09-29 17:35:50 +02:00
jakob.scheid e5362444b7 chore: remove unnecessary third-party licenses 
Removed unnecessary third-party licenses list in NOTICE and third-party
license texts in licenses/.
 2026-09-28 22:48:27 +02:00
jakob.scheid 6d1656745e Merge pull request 'Fix(python-generator): prevent from internal namespace error' (#55) from fix/project-dir-invalid-namespace-error into main
Generate API reference / generate (push) Successful in 23s
Details 
Reviewed-on: #55
 2026-09-28 22:36:32 +02:00
jakob.scheid 8881f2d46a docs(changelog): add namespace error fix entry 
Added a changelog entry for the namespace name error of the Python
project documentation generator.
 2026-09-28 22:35:31 +02:00
jakob.scheid 6a4b5187e7 fix(python-generator): resolve directory path 
The path to the directory is now completely resolved in
PythonDocumentationGenerator._namespace to prevent from empty path names
if the path is '.'. A fallback was also added for the case that the path
is '/'; the fallback value is irrelevant as the root namespace name is
not included in the output and only the root package path can be '/'.
 2026-09-28 22:35:26 +02:00
jcloud-bot Bot eabde41cec chore: update API reference 2026-09-27 23:28:05 +00:00
jakob.scheid cd35457301 Merge pull request 'Fix(ci): API reference configuration error' (#51) from fix/api-reference-workflow-config-error into main
Generate API reference / generate (push) Successful in 21s
Details 
Reviewed-on: #51
 2026-09-28 01:27:50 +02:00
jakob.scheid 6f2c0871c8 fix(ci): fix API reference configuration error 
Fixed a spelling error.
 2026-09-28 01:25:16 +02:00
jakob.scheid b2a8e54766 Merge pull request 'Chore: prepare release 0.2.0' (#49) from chore/prepare-0-2-0 into main
Release package / Build package (release) Successful in 24s
Details
Release package / Prepare release asset upload (release) Successful in 14s
Details
Release package / Publish package to package registry (release) Successful in 16s
Details
Release package / Upload release asset (${{ fromJSON(needs.prepare_upload_release_asset.outputs.files) }}) (release) Successful in 23s
Details 
Reviewed-on: #49
v0.2.0 v0.2.0-rc0 		2026-09-28 00:40:29 +02:00
jakob.scheid 773294f3d9 docs(changelog): move unreleased section to 0.2.0 2026-09-28 00:35:43 +02:00
jakob.scheid 200221e324 chore: update version in pyproject.toml to 0.2.0 2026-09-28 00:34:39 +02:00
jakob.scheid e8bcf4feb1 Merge pull request 'Fix(ci): spelling error in API reference workflow' (#48) from fix/fix-api-reference-spelling into main 
Reviewed-on: #48
 2026-09-28 00:31:45 +02:00
jakob.scheid ff3bddd366 fix(ci): fix spelling in API reference workflow 
Replaced '--chached' with '--cached' and replaced '--quit' with
'--quiet'.
 2026-09-28 00:29:11 +02:00
jakob.scheid e94365faf8 Merge pull request 'Chore(ci): adapt API reference workflow to the new API' (#45) from feature/adapt-api-reference-workflow-to-new-cli into main 
Reviewed-on: #45
 2026-09-28 00:22:39 +02:00
jakob.scheid 95da53898c chore(ci): adapt API reference workflow to new API 
Adapted the API reference generation workflow to the new API, which no
longer requires the src/ structure.
 2026-09-28 00:18:44 +02:00
jakob.scheid 4d2e63d560 refactor(ci): use force overwriting feature 2026-09-28 00:17:30 +02:00
jakob.scheid 2187590468 Merge pull request 'Refactor: lint code' (#43) from refactor/lint into main 
Reviewed-on: #43
 2026-09-28 00:08:30 +02:00
jakob.scheid 37308227d9 chore: add noqa comments to wildcard imports 
Added noqa comments to suppress linting warnings for wildcard imports.
 2026-09-28 00:04:53 +02:00
jakob.scheid f796263c0e fix: fix syntax errors (target version) 
Fixed all lines which were syntax errors in the target version (only
multi-line f-strings).
 2026-09-28 00:04:53 +02:00
jakob.scheid 896bfcc2dd style: use target version practices 2026-09-28 00:04:53 +02:00
jakob.scheid b2a7c9a0e3 style: fix lines which exceed the line length limit 2026-09-28 00:04:44 +02:00
jakob.scheid ac72eb283c style: organize imports 
Organized imports according to Ruff (I001).
 2026-09-27 22:23:58 +02:00
jakob.scheid 21c5c20cb5 Merge pull request 'Fix(python-generator): Python namespaces comparision type check' (#41) from fix/python-namespace-comparision-type-check into main 
Reviewed-on: #41
 2026-09-27 22:17:15 +02:00
jakob.scheid 3865db7919 test(python-generator): add test cases for package namespace comparision 
Added test cases with different types for Python package namespace
comparision test.
 2026-09-27 22:16:15 +02:00
jakob.scheid ec262ef99e feat(python-generator): check type at package namespace comparision 
Added type check to the Python package namespace comparision function.
 2026-09-27 22:15:57 +02:00
jakob.scheid f102fa80ce test(python-generator): add test cases for module namespace comparision 
Added test cases with different types for Python module namespace
comparision test.
 2026-09-27 22:15:55 +02:00
jakob.scheid 6d2b32a736 feat(python-generator): check type at module namespace comparision 
Added type check to the Python module namespace comparision function.
 2026-09-27 22:01:19 +02:00
jakob.scheid 934624fce3 Merge pull request 'Feat(python-generator): protection against accidental overwriting of the output directory' (#40) from feature/protect-against-accidental-overwriting into main 
Reviewed-on: #40
 2026-09-27 21:56:40 +02:00
jakob.scheid b043a4ea17 docs(changelog): add accidental overwriting protection entry 
Added a changelog entry for the protection against accidental
overwriting of the output directory.
 2026-09-27 17:37:51 +02:00
jakob.scheid f2b9f47e09 test(cli): add tests for Python force overwriting 
Added a test to the CLI test file for the documentation generation
error.
 2026-09-27 17:36:04 +02:00
jakob.scheid f0c271f8fd feat(cli): add Python generator force argument 2026-09-27 15:09:35 +02:00
jakob.scheid d8508e0fa3 test(python-generator): add tests for force overwriting 
Added tests to test new output directory deletion behavior:
  - output directory overwriting (not empty; force)
  - error (not empty; not force)
  - nothing (empty; force)
  - nothing (empty; not force)
One test was adapted to output directory emptiness check because the
.gitkeep file which is required for Git to track the directory makes it
non-empty.
 2026-09-27 15:09:17 +02:00
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
jakob.scheid 0261a7b3a6 feat(exceptions): add DirectoryNotEmptyError 
Added an OSError subclass for indicating that the directory is not
empty. This exception is explicitly handled by the CLI now.
 2026-09-26 16:28:40 +02:00
jakob.scheid 2fe342cbc6 Merge pull request 'Feat(python-generator): remove implicit assumptions of project directory structure' (#39) from feature/no-src-dir-need into main 
Reviewed-on: #39
 2026-09-22 19:28:50 +02:00
jakob.scheid 53ab0e3829 docs(changelog): add project directory structure entry 
Added an entry that the implicit Python project directory
structure assumptions have been removed to the changelog.
 2026-09-22 19:28:34 +02:00
jakob.scheid c40e965d8d test(python-generator): update tests to do not assume src/ directories 
Updated tests to do not implicitly assume a 'src/' directory structure
and removed all 'src/' subdirectory structures in test project
directories (if possible).
 2026-09-22 19:26:55 +02:00
jakob.scheid 0fbfe84657 feat(python-generator)!: do not require specific structure 
Removed all implicit assumptions of a project structure:
  - no 'src/' directory is required
  - top-level modules are no longer ignored
 2026-09-22 18:28:35 +02:00
jakob.scheid d0ea392f62 Merge pull request 'Feature(python-generator): output directory creation' (#37) from feature/ensure-output-dir-exists into main 
Reviewed-on: #37
 2026-09-22 17:11:04 +02:00
jakob.scheid 717a8c446e docs(changelog): add docs directory creation entry 
Added a changelog entry for the creation of the documentation directory
at the Python documentation generator.
 2026-09-22 17:08:15 +02:00
jakob.scheid ec156a538e test(python-generator): add test for directory creation 
Added a testing function which tests whether the documentation directory
is created when the documentation is generated.
 2026-09-22 17:04:56 +02:00
jakob.scheid e2264696e8 feat(python-generator): create output directory 
Now, the output directory and its parents are created when generating
the documentation.
 2026-09-22 17:00:34 +02:00
jakob.scheid 6cf3de156d Merge pull request 'Test(python-generator): name testing function correctly' (#36) from test/name-testing-functions-correctly into main 
Reviewed-on: #36
 2026-09-22 16:49:28 +02:00
jakob.scheid b6d2fa7db8 test(python-generator): name testing function correctly 2026-09-22 16:47:18 +02:00