Add API reference

docs/reference/jcloud_docsgen/exceptions.md

@@ -0,0 +1,253 @@
+# Module `jcloud_docsgen.exceptions`
+
+## Class `NamespaceError`
+
+Base class for namespace errors.
+
+### Base classes
+
+- `ValueError`
+
+### Body
+
+#### Constructor (method `__init__`)
+
+##### Method signature
+
+```python
+__init__(self, *args: object, namespace_identifier: str = '') -> None
+```
+
+##### Returns
+
+Return type: `None`
+
+##### Parameters
+
+| Parameter | Type | Kind | Default value | Description |
+| --- | --- | --- | --- | --- |
+| `self` | -- | normal | -- | -- |
+| `args` | `object` | vararg | -- | -- |
+| `namespace_identifier` | `str` | keyword-only | `''` | -- |
+
+#### Method `__str__`
+
+##### Method signature
+
+```python
+__str__(self)
+```
+
+
+
+##### Parameters
+
+| Parameter | Type | Kind | Default value | Description |
+| --- | --- | --- | --- | --- |
+| `self` | -- | normal | -- | -- |
+
+
+
+
+
+### Docstring
+
+Base class for namespace errors.
+
+## Class `InvalidNamespaceError`
+
+### Base classes
+
+- `NamespaceError`
+
+## Class `NamespaceNotFoundError`
+
+### Base classes
+
+- `NamespaceError`
+
+## Class `NamespaceExistsError`
+
+### Base classes
+
+- `NamespaceError`
+
+## Class `PythonIdentifierError`
+
+Base class for Python identifier errors.
+
+### Base classes
+
+- `ValueError`
+
+### Body
+
+#### Constructor (method `__init__`)
+
+##### Method signature
+
+```python
+__init__(self, *args: object, identifier: str = '') -> None
+```
+
+##### Returns
+
+Return type: `None`
+
+##### Parameters
+
+| Parameter | Type | Kind | Default value | Description |
+| --- | --- | --- | --- | --- |
+| `self` | -- | normal | -- | -- |
+| `args` | `object` | vararg | -- | -- |
+| `identifier` | `str` | keyword-only | `''` | -- |
+
+#### Method `__str__`
+
+##### Method signature
+
+```python
+__str__(self)
+```
+
+
+
+##### Parameters
+
+| Parameter | Type | Kind | Default value | Description |
+| --- | --- | --- | --- | --- |
+| `self` | -- | normal | -- | -- |
+
+
+
+
+
+### Docstring
+
+Base class for Python identifier errors.
+
+## Class `InvalidPythonIdentifierError`
+
+### Base classes
+
+- `PythonIdentifierError`
+
+## Class `PythonAnnotationError`
+
+Base class for Python annotation errors.
+
+### Base classes
+
+- `ValueError`
+
+### Body
+
+#### Constructor (method `__init__`)
+
+##### Method signature
+
+```python
+__init__(self, *args: object, annotation: str = '') -> None
+```
+
+##### Returns
+
+Return type: `None`
+
+##### Parameters
+
+| Parameter | Type | Kind | Default value | Description |
+| --- | --- | --- | --- | --- |
+| `self` | -- | normal | -- | -- |
+| `args` | `object` | vararg | -- | -- |
+| `annotation` | `str` | keyword-only | `''` | -- |
+
+#### Method `__str__`
+
+##### Method signature
+
+```python
+__str__(self)
+```
+
+
+
+##### Parameters
+
+| Parameter | Type | Kind | Default value | Description |
+| --- | --- | --- | --- | --- |
+| `self` | -- | normal | -- | -- |
+
+
+
+
+
+### Docstring
+
+Base class for Python annotation errors.
+
+## Class `InvalidPythonAnnotationError`
+
+### Base classes
+
+- `PythonAnnotationError`
+
+## Class `PythonDefinitionError`
+
+Base class for Python definition errors.
+
+### Base classes
+
+- `ValueError`
+
+### Body
+
+#### Constructor (method `__init__`)
+
+##### Method signature
+
+```python
+__init__(self, *args: object, definition: str = '') -> None
+```
+
+##### Returns
+
+Return type: `None`
+
+##### Parameters
+
+| Parameter | Type | Kind | Default value | Description |
+| --- | --- | --- | --- | --- |
+| `self` | -- | normal | -- | -- |
+| `args` | `object` | vararg | -- | -- |
+| `definition` | `str` | keyword-only | `''` | -- |
+
+#### Method `__str__`
+
+##### Method signature
+
+```python
+__str__(self)
+```
+
+
+
+##### Parameters
+
+| Parameter | Type | Kind | Default value | Description |
+| --- | --- | --- | --- | --- |
+| `self` | -- | normal | -- | -- |
+
+
+
+
+
+### Docstring
+
+Base class for Python definition errors.
+
+## Class `PythonArgumentStructureError`
+
+### Base classes
+
+- `PythonDefinitionError`