parselglossy.documentation module
Documentation generation.
-
parselglossy.documentation.document_keyword(keyword: Dict[str, Any]) → str[source]
-
parselglossy.documentation.documentation_generator(template: Dict[str, Any], *, header: str = 'Input parameters') → str[source]
Generates documentation from a valid template.
| Parameters: | template (JSONDict) – The template to generate documentation from.
We assume that the template is valid. |
|---|
| Returns: | documentation |
|---|
| Return type: | str |
|---|
-
parselglossy.documentation.indent(in_str: str, level: int = 0) → str[source]
-
parselglossy.documentation.rec_documentation_generator(template, *, level: int = 0) → str[source]
Generates documentation from a valid template.
| Parameters: |
- template (JSONDict) –
- level (int) –
|
|---|
| Returns: | docs
|
|---|
| Return type: | str
|
|---|