Merge pull request 'Chore: prepare release 0.1.0' (#4) from chore/prepare-0-1-0 into main
Release package / Build package (release) Failing after 20s
Release package / Publish package to package registry (release) Skipped
Release package / Prepare release asset upload (release) Failing after 13s
Release package / Upload release asset (${{ fromJSON(needs.prepare_upload_release_asset.outputs.files) }}) (release) Skipped

Reviewed-on: #4
This commit was merged in pull request #4.
This commit is contained in:
jakob.scheid authored and Gitea committed 2026-09-03 17:18:38 +02:00
commit 42f8a65933
2 files changed
+10 -25

No files matched your search

+9 -24
View File
@@ -1,29 +1,14 @@
# Changelog # Changelog
## [Unreleased] ## [0.1.0] - 2026-09-01
### Added ### Added
- Add class for existing directories - utility class for existing directories
- Add function to format a list human-readable - utility class for existing files
- Add function to assert that an object is an instance of a specific type - Python project documentation generator
- Add Python project documentation generator class - Python definition documentation generator
- Add Python namespaces classes - Python module documentation generator
- Add type checking for the `name` attribute at the constructor of `core.python.namespaces.PythonNamespace` - Python namespaces
- Add check whether sub-namespaces are not empty in `core.python.namespaces.PythonPackageNamespace.namespace` - signature representation of a Python function argument
- Add feature to get the names of all sub-namespaces of a `core.python.namespaces.PythonPackageNamespace` - Python docstrings
- Add feature to compare `core.python.namespaces.PythonPackageNamespace` instances or `core.python.namespaces.PythonModuleNamespace` instances
- Add string representation for Python namespace objects
- Add `PythonDocumentationGenerator` method to collect all namespaces
- Add class for existing files
- Add classes for Python function arguments
- Add classes for Python definitions
- Add class for Python modules
- Add feature to get the signature representation of a Python function argument
- Add class for Python docstrings
- Add feature to parse Python docstrings
- Add function to ensure a non-empty string.
- Add Python definition documentation generator
- Add function to get the path segments of a path relative to another
- Add Python module documentation generator
- Add Python project documentation generator
+1 -1
View File
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
[project] [project]
name = "jcloud-docsgen" name = "jcloud-docsgen"
version = "1.0.0" version = "0.1.0"
description = "A tool that generates Markdown documentation for software project source code" description = "A tool that generates Markdown documentation for software project source code"
dependencies = ["docstring-parser"] dependencies = ["docstring-parser"]
license = "Apache-2.0" license = "Apache-2.0"