chore: update API reference

docs/reference/jcloud_docsgen/cli/__init__.md

@@ -0,0 +1 @@
+# Module `jcloud_docsgen.cli.__init__`

docs/reference/jcloud_docsgen/cli/cli.md

@@ -0,0 +1,107 @@
+# Module `jcloud_docsgen.cli.cli`
+
+The command line interface
+
+## Function `existing_directory`
+
+### Function signature
+
+```python
+existing_directory(path: str) -> pathlib.Path
+```
+
+### Returns
+
+Return type: `pathlib.Path`
+
+### Parameters
+
+| Parameter | Type | Kind | Default value | Description |
+| --- | --- | --- | --- | --- |
+| `path` | `str` | normal | -- | -- |
+
+## Function `error`
+
+Shows an error message and returns the exit code.
+
+
+### Function signature
+
+```python
+error(message: str, exit_code: int = 1)
+```
+
+
+
+### Parameters
+
+| Parameter | Type | Kind | Default value | Description |
+| --- | --- | --- | --- | --- |
+| `message` | `str` | normal | -- | The error message to show. |
+| `exit_code` | `int` | normal | `1` | The exit code. |
+
+
+
+
+
+
+
+### Docstring
+
+Shows an error message and returns the exit code.
+
+:param message: The error message to show.
+:type message: str
+:param exit_code: The exit code.
+:type exit_code: int
+
+## Function `create_argument_parser`
+
+Prepares a parser to parse the command-line arguments using
+argparse.
+
+### Function signature
+
+```python
+create_argument_parser() -> argparse.ArgumentParser
+```
+
+### Returns
+
+The parser.
+
+Return type: `argparse.ArgumentParser`
+
+
+
+
+
+
+
+
+
+### Docstring
+
+Prepares a parser to parse the command-line arguments using
+argparse.
+
+:return: The parser.
+:rtype: argparse.ArgumentParser
+
+## Function `main`
+
+### Function signature
+
+```python
+main(argv=None) -> int
+```
+
+### Returns
+
+Return type: `int`
+
+### Parameters
+
+| Parameter | Type | Kind | Default value | Description |
+| --- | --- | --- | --- | --- |
+| `argv` | -- | normal | `None` | -- |

docs/reference/jcloud_docsgen/cli/languages/__init__.md

@@ -0,0 +1 @@
+# Module `jcloud_docsgen.cli.languages.__init__`

docs/reference/jcloud_docsgen/cli/languages/python.md

@@ -0,0 +1,156 @@
+# Module `jcloud_docsgen.cli.languages.python`
+
+## Function `parse_sections_list`
+
+Returns a Python definition documentation sections list from the
+sections list to be included and the sections list to be excluded.
+These lists both consist of the sections as strings which contain
+the section name.
+
+### Function signature
+
+```python
+parse_sections_list(include_sections: list[str] | None = None, exclude_sections: list[str] = []) -> PythonDefinitionDocumentationIncludeSections
+```
+
+### Returns
+
+The Python definition documentation sections object.
+
+Return type: `PythonDefinitionDocumentationIncludeSections`
+
+### Parameters
+
+| Parameter | Type | Kind | Default value | Description |
+| --- | --- | --- | --- | --- |
+| `include_sections` | `list[str] | None` | normal | `None` | The list of sections to be included. |
+| `exclude_sections` | `list[str]` | normal | `[]` | The list of sections to be excluded. |
+
+
+
+
+
+
+
+### Docstring
+
+Returns a Python definition documentation sections list from the
+sections list to be included and the sections list to be excluded.
+These lists both consist of the sections as strings which contain
+the section name.
+
+:param include_sections: The list of sections to be included.
+:type include_sections: list[str] | None
+:param exclude_sections: The list of sections to be excluded.
+:type exclude_sections: list[str]
+
+:return: The Python definition documentation sections object.
+:rtype: PythonDefinitionDocumentationIncludeSections
+
+## Function `_generate`
+
+Generates the documentation for a Python project.
+
+
+### Function signature
+
+```python
+_generate(project_directory: pathlib.Path, output_directory: pathlib.Path, *, include_sections: PythonDefinitionDocumentationIncludeSections = PythonDefinitionDocumentationIncludeSections(), allow_html: bool = False, allow_tables: bool = False, force: bool = False) -> None
+```
+
+### Returns
+
+Return type: `None`
+
+### Parameters
+
+| Parameter | Type | Kind | Default value | Description |
+| --- | --- | --- | --- | --- |
+| `project_directory` | `pathlib.Path` | normal | -- | The project directory. |
+| `output_directory` | `pathlib.Path` | normal | -- | The output directory. |
+| `include_sections` | `PythonDefinitionDocumentationIncludeSections` | keyword-only | `PythonDefinitionDocumentationIncludeSections()` | The sections to be included in the documentation. |
+| `allow_html` | `bool` | keyword-only | `False` | Indicates whether HTML is allowed to appear in the generated documentation. |
+| `allow_tables` | `bool` | keyword-only | `False` | Indicates whether Markdown tables are allowed. Warning: Markdown tables are not CommonMark. |
+| `force` | `bool` | keyword-only | `False` | Indicates whether the output directory shall be overwritten if it is not empty. |
+
+
+
+
+
+
+
+### Docstring
+
+Generates the documentation for a Python project.
+
+:param project_directory: The project directory.
+:type project_directory: pathlib.Path
+:param output_directory: The output directory.
+:type output_directory: pathlib.Path
+:param include_sections: The sections to be included in the
+                         documentation.
+:type include_sections: PythonDefinitionDocumentationIncludeSections
+:param allow_html: Indicates whether HTML is allowed to appear in
+                   the generated documentation.
+:type allow_html: bool
+:param allow_tables: Indicates whether Markdown tables are allowed.
+                     Warning: Markdown tables are not CommonMark.
+:param force: Indicates whether the output directory shall be
+              overwritten if it is not empty.
+:type force: bool
+
+## Function `generate`
+
+Generates the documentation for a Python project.
+
+
+### Function signature
+
+```python
+generate(project_directory: pathlib.Path, output_directory: pathlib.Path, *, include_sections: list[str] | None = None, exclude_sections: list[str] = [], allow_html: bool = False, allow_tables: bool = False, force: bool = False) -> None
+```
+
+### Returns
+
+Return type: `None`
+
+### Parameters
+
+| Parameter | Type | Kind | Default value | Description |
+| --- | --- | --- | --- | --- |
+| `project_directory` | `pathlib.Path` | normal | -- | The project directory. |
+| `output_directory` | `pathlib.Path` | normal | -- | The output directory. |
+| `include_sections` | `list[str] | None` | keyword-only | `None` | The sections to be included in the documentation. |
+| `exclude_sections` | `list[str]` | keyword-only | `[]` | The sections to be excluded in the documentation. |
+| `allow_html` | `bool` | keyword-only | `False` | Indicates whether HTML is allowed to appear in the generated documentation. |
+| `allow_tables` | `bool` | keyword-only | `False` | Indicates whether Markdown tables are allowed. Warning: Markdown tables are not CommonMark. |
+| `force` | `bool` | keyword-only | `False` | Indicates whether the output directory shall be overwritten if it is not empty. |
+
+
+
+
+
+
+
+### Docstring
+
+Generates the documentation for a Python project.
+
+:param project_directory: The project directory.
+:type project_directory: pathlib.Path
+:param output_directory: The output directory.
+:type output_directory: pathlib.Path
+:param include_sections: The sections to be included in the
+                         documentation.
+:type include_sections: list[str] | None
+:param exclude_sections: The sections to be excluded in the
+                         documentation.
+:type exclude_sections: list[str]
+:param allow_html: Indicates whether HTML is allowed to appear in
+                   the generated documentation.
+:type allow_html: bool
+:param allow_tables: Indicates whether Markdown tables are allowed.
+                     Warning: Markdown tables are not CommonMark.
+:param force: Indicates whether the output directory shall be
+              overwritten if it is not empty.
+:type force: bool