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
164 Commits 1 Branch 13 Tags
cfc00dadb2aa19baa386b47a0895912a9d43b7e6
Commit Graph
164 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
jakob.scheid cfc00dadb2 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 18:35:27 +02:00
jakob.scheid 264d9a76dc 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 18:28:40 +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
jakob.scheid 63cef6f641 Merge pull request 'Fix(python-generator): make generated signatures compliant with PEP 8' (#35) from fix/python-signatures-pep-8-compliance into main 
Reviewed-on: #35
 2026-09-22 16:15:35 +02:00
jakob.scheid 06802c96f6 docs(changelog): add Python signatures PEP 8 compliance entry 
Added a changelog entry for the PEP 8 compliance of Python function
signatures default values.
 2026-09-22 16:13:43 +02:00
jakob.scheid 17c5e4938f test(python-generator): update tests for PEP 8 compliance 
Updated test cases to the new default value PEP 8 compliance and added
new test cases to test the new behavior.
 2026-09-22 16:13:23 +02:00
jakob.scheid cc786a6c69 fix(python-generator): make signatures compliant with PEP 8 
The '=' character at a parameter in the signature was surrounded with
spaces previously. That is no longer the case, unless there is a type
hint.
 2026-09-22 15:55:57 +02:00
jakob.scheid 274ed45167 Merge pull request 'Chore(ci): add workflow to generate API reference' (#29) from chore/api-reference-workflow into main 
Reviewed-on: #29
 2026-09-22 13:26:43 +02:00
jakob.scheid 62206db574 docs(changelog): add entry for API reference pipeline 
Added a changelog entry for the CI pipeline which generated the API
reference.
 2026-09-22 13:16:35 +02:00
jakob.scheid 89451c34e3 chore(ci): add workflow to generate API reference 
Added a workflow which generates the API reference and commits and
pushes it.
 2026-09-22 13:15:47 +02:00
jakob.scheid f6dbefaf6c Merge pull request 'Docs(readme): reference to Gitea Package Registry instead of concrete installation instructions' (#28) from docs/remove-readme-installation-instructions into main 
Reviewed-on: #28
 2026-09-22 12:45:32 +02:00
jakob.scheid 1a230abf02 docs(changelog): add package registry reference entry 
Added an entry for the installation instructions update in README to the
changelog.
 2026-09-22 12:43:19 +02:00
jakob.scheid 14d6a8984a docs(readme): update installation instructions 
Previously, there were instructions how to install the package (over the
old registry) in README.md. They were replaced with a reference to the
Gitea Package Registry.
 2026-09-22 12:37:10 +02:00
jakob.scheid 56f650d0ad Merge pull request 'Chore: conventional commit messages template' (#25) from chore/conventional-commit-msg-template into main 
Reviewed-on: #25
 2026-09-21 22:31:28 +02:00
jakob.scheid 25a92d710e chore: add setup script 
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
jakob.scheid a55d4d4f79 chore: add commit message template 
Added a commit message template for conventional commits line
length limits.
 2026-09-21 22:21:40 +02:00
jakob.scheid 24673a45a5 Merge pull request 'Refactor(python-generator): rename misnamed testing function' (#23) from refactor/package-namespace-testing-function-name into main 
Reviewed-on: #23
 2026-09-21 22:14:42 +02:00
jakob.scheid 0e81d0b9ca refactor(python-generator): rename misnamed testing function 
Renamed 'test_PythonPackageNamespace___getitem__' to
'test_PythonPackageNamespace_add'.
 2026-09-21 22:12:00 +02:00
jakob.scheid b5f67caa69 Merge pull request 'Chore(lint): set up Ruff, lint and format' (#22) from chore/ruff into main 
Reviewed-on: #22
 2026-09-21 22:06:22 +02:00
jakob.scheid de3eac3bb1 chore: lint source code using Ruff 2026-09-21 20:10:09 +02:00
jakob.scheid aa4a139878 style: format source code using Ruff 2026-09-21 20:10:04 +02:00
jakob.scheid d9887f34c9 chore(ruff): add Ruff configuration 2026-09-18 22:40:39 +02:00
jakob.scheid 178e6b0bd8 chore(deps): add Ruff dependency 2026-09-18 22:31:09 +02:00
jakob.scheid f680110110 Merge pull request 'Style: trailing commas in multi-line statements' (#21) from style/multiline-trailing-commas into main 
Reviewed-on: #21
 2026-09-18 22:22:15 +02:00
jakob.scheid 475775eb7e style: ensure trailing commas in multi-line statements 2026-09-18 22:18:13 +02:00
jakob.scheid ffcc7404de Merge pull request 'Style: ensure line character limit and remove trailing whitespace' (#19) from style/pip-8-compliance into main 
Reviewed-on: #19
 2026-09-18 17:12:59 +02:00
jakob.scheid 23e450e9df style: remove trailing whitespace 
Removed all trailing whitespace.
 2026-09-18 17:02:09 +02:00
jakob.scheid caa8e04047 style: limit line length to 79 characters 
Limited the lengths of all lines to 79 characters (if possible).
Additionally, some other lines were breaked for consistence.
 2026-09-18 16:57:45 +02:00
jakob.scheid 8930efc7e6 Merge pull request 'Feature(cli): add base command-line interface' (#16) from feature/cli into main 
Reviewed-on: #16
 2026-09-13 20:11:00 +02:00
jakob.scheid 1ce3d8f9d1 refactor(cli): remove unnecessary, redundant __all__ 2026-09-13 20:10:22 +02:00
jakob.scheid 56588e6c78 fix: jcloud_docsgen.cli instead of jcloud_docsgen.cli.cli in pyproject.toml 2026-09-13 20:09:02 +02:00
jakob.scheid bd7780f112 test(cli): add tests for Python sections list parser 2026-09-13 19:04:55 +02:00
jakob.scheid 5e84156e01 fix(cli): copy VALID_SECTIONS when parsing sections list 2026-09-13 19:04:54 +02:00
jakob.scheid 089cf5f2ff refactor(cli): move sections list parsing to function 2026-09-13 19:04:54 +02:00
jakob.scheid 8644232a00 feat: add __main__ module 
Added a __main__ module that calls the CLI main function.
 2026-09-13 19:04:54 +02:00
jakob.scheid 2cb99d4ca9 feat(cli): add cli module to cli package __init__ module 2026-09-13 19:04:54 +02:00
jakob.scheid 8f5dc33369 feat(cli): import languages package 2026-09-13 19:04:54 +02:00
jakob.scheid e2e6a59d13 docs(changelog): update CLI entry 2026-09-13 19:04:53 +02:00
jakob.scheid 84fe67230f test(cli): add tests for the CLI 2026-09-13 19:04:41 +02:00
jakob.scheid 348be4f07f refactor(cli): rename 'parsers' package to 'languages' 2026-09-10 15:52:05 +02:00
jakob.scheid db0d36f956 feat(cli): add __all__ to cli.cli module 2026-09-10 13:37:45 +02:00
jakob.scheid 29d1c5bced refactor(cli): move parser creation to a function 2026-09-10 13:36:06 +02:00
jakob.scheid 3ab9884be0 feat(cli): add error handling 
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
jakob.scheid 60a097f0cc feat(cli): allow to pass command line arguments to function 2026-09-10 09:58:18 +02:00