generated from jCloud/repository-template
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
This commit is contained in:
2 files changed
+7
-13
No files matched your search
@@ -78,6 +78,7 @@ def create_argument_parser() -> argparse.ArgumentParser:
|
||||
'-o',
|
||||
'--output-dir',
|
||||
type=pathlib.Path,
|
||||
default='docs/reference',
|
||||
help='the output directory the documentation will be written to',
|
||||
)
|
||||
|
||||
@@ -138,9 +139,6 @@ def main(argv=None) -> int:
|
||||
argument_parser = create_argument_parser()
|
||||
args = argument_parser.parse_args(argv)
|
||||
|
||||
if args.output_dir is None:
|
||||
args.output_dir = args.project_directory / 'docs/reference'
|
||||
|
||||
try:
|
||||
if args.language == _LANG_PYTHON:
|
||||
from .languages.python import generate
|
||||
|
||||
@@ -1104,19 +1104,15 @@ class PythonDocumentationGenerator:
|
||||
|
||||
return namespace
|
||||
|
||||
def namespace(self) -> list[PythonPackageNamespace]:
|
||||
def namespace(self) -> PythonPackageNamespace:
|
||||
"""
|
||||
Returns the project as a namespace.
|
||||
|
||||
:return: The project as a namespace.
|
||||
:rtype: list[PythonPackageNamespace]
|
||||
:rtype: PythonPackageNamespace:
|
||||
"""
|
||||
|
||||
src_dir = self.project_directory / 'src'
|
||||
|
||||
return [
|
||||
self._namespace(dir) for dir in src_dir.iterdir() if dir.is_dir()
|
||||
]
|
||||
return self._namespace(self.project_directory)
|
||||
|
||||
def generate_documentation(self) -> None:
|
||||
"""
|
||||
@@ -1127,10 +1123,10 @@ class PythonDocumentationGenerator:
|
||||
self.docs_directory.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
_generate_package_namespace_documentation(
|
||||
PythonPackageNamespace('src', self.namespace()),
|
||||
self.namespace(),
|
||||
self.docs_directory,
|
||||
self.project_directory / 'src',
|
||||
self.project_directory / 'src',
|
||||
self.project_directory,
|
||||
self.project_directory,
|
||||
self.include_sections,
|
||||
self.kwargs,
|
||||
)
|
||||
Reference in new issue
Block a user