Add support for concatinating multi line notes and description

Author: lukasmasuch

docs/README.md

@@ -14,6 +14,7 @@
 - [`generate_docs`](./lazydocs.generation.md#function-generate_docs): Generates markdown documentation for provided paths based on Google-style docstrings.
 - [`to_md_file`](./lazydocs.generation.md#function-to_md_file): Creates an API docs file from a provided text.
 
+
 ---
 
 _This file was automatically generated via [lazydocs](https://github.com/ml-tooling/lazydocs)._

docs/lazydocs.generation.md

@@ -2,12 +2,12 @@
 <a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L0"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 # <kbd>module</kbd> `lazydocs.generation`
-Main module for markdown generation.
+Main module for markdown generation. 
 
 
 ---
 
-<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L172"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L177"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `to_md_file`
 
@@ -20,24 +20,21 @@ to_md_file(
 ) → None
 ```
 
-Creates an API docs file from a provided text.
+Creates an API docs file from a provided text. 
 
 
-**Args:**
-
-
- - <b>`string`</b> (str):  String with line breaks to write to file.
 
- - <b>`filename`</b> (str):  Filename without the .md
-
- - <b>`watermark`</b> (bool):  If `True`, add a watermark with a timestamp to bottom of the markdown files.
-
- - <b>`out_path`</b> (str):  The output directory
+**Args:**
+ 
+ - <b>`string`</b> (str):  String with line breaks to write to file. 
+ - <b>`filename`</b> (str):  Filename without the .md 
+ - <b>`watermark`</b> (bool):  If `True`, add a watermark with a timestamp to bottom of the markdown files. 
+ - <b>`out_path`</b> (str):  The output directory 
 
 
 ---
 
-<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L757"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L788"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `generate_docs`
 
@@ -55,41 +52,32 @@ generate_docs(
 ) → None
 ```
 
-Generates markdown documentation for provided paths based on Google-style docstrings.
-
-
-**Args:**
-
-
- - <b>`paths`</b>:  Selected paths or import name for markdown generation.
-
- - <b>`output_path`</b>:  The output path for the creation of the markdown files. Set this to `stdout` to print all markdown to stdout.
+Generates markdown documentation for provided paths based on Google-style docstrings. 
 
- - <b>`src_root_path`</b>:  The root folder name containing all the sources. Fallback to git repo root.
 
- - <b>`src_base_url`</b>:  The base url of the github link. Should include branch name. All source links are generated with this prefix.
 
- - <b>`remove_package_prefix`</b>:  If `True`, the package prefix will be removed from all functions and methods.
-
- - <b>`ignored_modules`</b>:  A list of modules that should be ignored.
-
- - <b>`overview_file`</b>:  Filename of overview file. If not provided, no overview file will be generated.
-
- - <b>`watermark`</b>:  If `True`, add a watermark with a timestamp to bottom of the markdown files.
-
- - <b>`validate`</b>:  If `True`, validate the docstrings via pydocstyle. Requires pydocstyle to be installed.
+**Args:**
+ 
+ - <b>`paths`</b>:  Selected paths or import name for markdown generation. 
+ - <b>`output_path`</b>:  The output path for the creation of the markdown files. Set this to `stdout` to print all markdown to stdout. 
+ - <b>`src_root_path`</b>:  The root folder name containing all the sources. Fallback to git repo root. 
+ - <b>`src_base_url`</b>:  The base url of the github link. Should include branch name. All source links are generated with this prefix. 
+ - <b>`remove_package_prefix`</b>:  If `True`, the package prefix will be removed from all functions and methods. 
+ - <b>`ignored_modules`</b>:  A list of modules that should be ignored. 
+ - <b>`overview_file`</b>:  Filename of overview file. If not provided, no overview file will be generated. 
+ - <b>`watermark`</b>:  If `True`, add a watermark with a timestamp to bottom of the markdown files. 
+ - <b>`validate`</b>:  If `True`, validate the docstrings via pydocstyle. Requires pydocstyle to be installed. 
 
 
 ---
 
-<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L247"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L252"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>class</kbd> `MarkdownGenerator`
-Markdown generator class.
-
+Markdown generator class. 
 
 
-<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L250"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L255"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `__init__`
 
@@ -101,162 +89,154 @@ __init__(
 )
 ```
 
-Initializes the markdown API generator.
+Initializes the markdown API generator. 
 
 
-**Args:**
-
-
- - <b>`src_root_path`</b>:  The root folder name containing all the sources.
 
- - <b>`src_base_url`</b>:  The base github link. Should include branch name.
- All source links are generated with this prefix.
-
- - <b>`remove_package_prefix`</b>:  If `True`, the package prefix will be removed from all functions and methods.
+**Args:**
+ 
+ - <b>`src_root_path`</b>:  The root folder name containing all the sources. 
+ - <b>`src_base_url`</b>:  The base github link. Should include branch name.  All source links are generated with this prefix. 
+ - <b>`remove_package_prefix`</b>:  If `True`, the package prefix will be removed from all functions and methods. 
 
 
 
 ---
 
-<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L516"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L540"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `class2md`
 
 ```python
 class2md(cls: Any, depth: int = 2) → str
 ```
 
-Takes a class and creates markdown text to document its methods and variables.
-
+Takes a class and creates markdown text to document its methods and variables. 
 
-**Args:**
 
 
- - <b>`cls`</b> (class):  Selected class for markdown generation.
+**Args:**
+ 
+ - <b>`cls`</b> (class):  Selected class for markdown generation. 
+ - <b>`depth`</b> (int, optional):  Number of # to append to function name. Defaults to 2. 
 
- - <b>`depth`</b> (int, optional):  Number of # to append to function name. Defaults to 2.
 
 
 **Returns:**
-
-
- - <b>`str`</b>:  Markdown documentation for selected class.
+ 
+ - <b>`str`</b>:  Markdown documentation for selected class. 
 
 ---
 
-<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L339"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L344"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `doc2md`
 
 ```python
 doc2md(obj: Any) → str
 ```
 
-Parse docstring (with getdoc) according to Google-style formatting and convert to markdown.
+Parse docstring (with getdoc) according to Google-style formatting and convert to markdown. 
 
 
-**Args:**
 
+**Args:**
+ 
+ - <b>`obj`</b>:  Selected object for markdown generation. 
 
- - <b>`obj`</b>:  Selected object for markdown generation.
 
 
 **Returns:**
-
-
- - <b>`str`</b>:  Markdown documentation for docstring of selected object.
+ 
+ - <b>`str`</b>:  Markdown documentation for docstring of selected object. 
 
 ---
 
-<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L434"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L458"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `func2md`
 
 ```python
 func2md(func: Callable, clsname: str = '', depth: int = 3) → str
 ```
 
-Takes a function (or method) and generates markdown docs.
-
-
-**Args:**
+Takes a function (or method) and generates markdown docs. 
 
 
- - <b>`func`</b> (Callable):  Selected function (or method) for markdown generation.
 
- - <b>`clsname`</b> (str, optional):  Class name to prepend to funcname. Defaults to "".
+**Args:**
+ 
+ - <b>`func`</b> (Callable):  Selected function (or method) for markdown generation. 
+ - <b>`clsname`</b> (str, optional):  Class name to prepend to funcname. Defaults to "". 
+ - <b>`depth`</b> (int, optional):  Number of # to append to class name. Defaults to 3. 
 
- - <b>`depth`</b> (int, optional):  Number of # to append to class name. Defaults to 3.
 
 
 **Returns:**
-
-
- - <b>`str`</b>:  Markdown documentation for selected function.
+ 
+ - <b>`str`</b>:  Markdown documentation for selected function. 
 
 ---
 
-<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L690"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L721"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `import2md`
 
 ```python
 import2md(obj: Any, depth: int = 1) → str
 ```
 
-Generates markdown documentation for a selected object/import.
-
+Generates markdown documentation for a selected object/import. 
 
-**Args:**
 
 
- - <b>`obj`</b> (Any):  Selcted object for markdown docs generation.
+**Args:**
+ 
+ - <b>`obj`</b> (Any):  Selcted object for markdown docs generation. 
+ - <b>`depth`</b> (int, optional):  Number of # to append before heading. Defaults to 1. 
 
- - <b>`depth`</b> (int, optional):  Number of # to append before heading. Defaults to 1.
 
 
 **Returns:**
-
-
- - <b>`str`</b>:  Markdown documentation of selected object.
+ 
+ - <b>`str`</b>:  Markdown documentation of selected object. 
 
 ---
 
-<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L603"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L634"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `module2md`
 
 ```python
 module2md(module: module, depth: int = 1) → str
 ```
 
-Takes an imported module object and create a Markdown string containing functions and classes.
-
+Takes an imported module object and create a Markdown string containing functions and classes. 
 
-**Args:**
 
 
- - <b>`module`</b> (types.ModuleType):  Selected module for markdown generation.
+**Args:**
+ 
+ - <b>`module`</b> (types.ModuleType):  Selected module for markdown generation. 
+ - <b>`depth`</b> (int, optional):  Number of # to append before module heading. Defaults to 1. 
 
- - <b>`depth`</b> (int, optional):  Number of # to append before module heading. Defaults to 1.
 
 
 **Returns:**
-
-
- - <b>`str`</b>:  Markdown documentation for selected module.
+ 
+ - <b>`str`</b>:  Markdown documentation for selected module. 
 
 ---
 
-<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L710"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L741"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `overview2md`
 
 ```python
 overview2md() → str
 ```
 
-Generates a documentation overview file based on the generated docs.
+Generates a documentation overview file based on the generated docs.