generated from jCloud/repository-template
59 lines
1.6 KiB
Markdown
59 lines
1.6 KiB
Markdown
# Changelog
|
|
|
|
## [0.2.3] - 2026-10-21
|
|
|
|
### Fixed
|
|
|
|
- Escape sequences for pipe characters in values of Markdown table cells
|
|
|
|
## [0.2.2] - 2026-10-14
|
|
|
|
### Fixed
|
|
|
|
- Import error in Python <3.13 which prevented the tool from running and made it unusuable in Python <3.13
|
|
|
|
## [0.2.1] - 2026-10-06
|
|
|
|
### Fixed
|
|
|
|
- Python namespace name conflict when package and module have the same name
|
|
- Internal namespace name error which occured when generating Python documentation with `.` as the project directory
|
|
- Ignore Python namespaces with invalid names during documentation generation
|
|
|
|
### Changed
|
|
|
|
- Stricter Python namespace name validation
|
|
|
|
## [0.2.0] - 2026-09-28
|
|
|
|
### Added
|
|
|
|
- CLI for `jcloud-docsgen` that can be called without `python3 -m ...`
|
|
- CI pipeline to generate API reference on every push or merge on `main`
|
|
- Python generator output directory creation
|
|
- Protection against accidental overwriting of the output directory
|
|
|
|
### Changed
|
|
|
|
- Replaced the installation instructions, which used the old registry, with a reference to the Gitea Package Registry in README
|
|
- Made Python function signatures (argument default values) compliant with PEP 8
|
|
- Removed implicit Python project directory structure assumptions
|
|
|
|
### Deprecated
|
|
|
|
- utility class for existing directories
|
|
- utility class for existing files
|
|
|
|
## [0.1.0] - 2026-09-01
|
|
|
|
### Added
|
|
|
|
- utility class for existing directories
|
|
- utility class for existing files
|
|
- Python project documentation generator
|
|
- Python definition documentation generator
|
|
- Python module documentation generator
|
|
- Python namespaces
|
|
- signature representation of a Python function argument
|
|
- Python docstrings
|