2 Commits
Author SHA1 Message Date
jakob.scheid b1213e1f24 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:28:36 +02:00
jakob.scheid d1c9839ec7 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 does
not occur in the output and only the root package path can be '/'.
2026-09-28 22:26:32 +02:00
2 changed files with 14 additions and 1 deletions

No files matched your search

+6
View File
@@ -1,5 +1,11 @@
# Changelog
## [Unreleased]
### Fixed
- Internal namespace name error which occured when generating Python documentation with `.` as the project directory
## [0.2.0] - 2026-09-28
### Added
+8 -1
View File
@@ -1096,7 +1096,14 @@ class PythonDocumentationGenerator:
self.kwargs = kwargs
def _namespace(self, directory: pathlib.Path) -> PythonPackageNamespace:
namespace = PythonPackageNamespace(directory.name, [])
namespace = PythonPackageNamespace(
# fallback for the case that the path it '/'. In this case, the
# name would be ''. The fallback value is irrelevant; the name is
# only specified because PythonPackageNamespace requires
# specifying it. The name will not occur in the generated output.
directory.resolve().name or 'project',
[],
)
for entry in directory.iterdir():
if entry.is_dir():