Update readme and API docs

Author: lukasmasuch

README.md

@@ -17,12 +17,10 @@
 
 <p align="center">
   <a href="#getting-started">Getting Started</a> •
-  <a href="#features">Features & Screenshots</a> •
+  <a href="#features">Features</a> •
   <a href="#documentation">Documentation</a> •
   <a href="#support--feedback">Support</a> •
   <a href="https://github.com/ml-tooling/lazydocs/issues/new?labels=bug&template=01_bug-report.md">Report a Bug</a> •
-  <a href="#faq">FAQ</a> •
-  <a href="#known-issues">Known Issues</a> •
   <a href="#contribution">Contribution</a> •
   <a href="https://github.com/ml-tooling/lazydocs/releases">Changelog</a>
 </p>
@@ -31,9 +29,9 @@ Lazydocs makes it easy to generate beautiful markdown documentation for your Pyt
 
 ## Highlights
 
-- ⏱&emsp;Simple CLI to generate markdown docs in seconds.
-- 📋&emsp;Supports [Google-style Python Docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html).
-- 📚&emsp;Compatible with Github Markdown and MkDocs.
+- ⏱&nbsp; Simple CLI to generate markdown docs in seconds.
+- 📋&nbsp; Supports [Google-style Python Docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html).
+- 📚&nbsp; Compatible with Github Markdown and MkDocs.
 
 ## Getting Started
 
@@ -49,11 +47,11 @@ This project is maintained by [Benjamin Räthlein](https://twitter.com/raethlein
 
 | Type                     | Channel                                              |
 | ------------------------ | ------------------------------------------------------ |
-| 🚨&emsp;**Bug Reports**       | <a href="https://github.com/ml-tooling/lazydocs/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+label%3Abug+sort%3Areactions-%2B1-desc+" title="Open Bug Report"><img src="https://img.shields.io/github/issues/ml-tooling/lazydocs/bug.svg?label=bug"></a>                                 |
-| 🎁&emsp;**Feature Requests**  | <a href="https://github.com/ml-tooling/lazydocs/issues?q=is%3Aopen+is%3Aissue+label%3Afeature+sort%3Areactions-%2B1-desc" title="Open Feature Request"><img src="https://img.shields.io/github/issues/ml-tooling/lazydocs/feature.svg?label=feature"></a>                                 |
-| 👩‍💻&emsp;**Usage Questions**   |  _tbd_ |
-| 🗯&emsp;**General Discussion** | _tbd_ |
-| ❓&emsp;**Other Requests** | <a href="mailto:[email protected]" title="Email ML Tooling Team"><img src="https://img.shields.io/badge/email-ML Tooling-green?logo=mail.ru&style=flat-square&logoColor=white"></a> |
+| 🚨&nbsp; **Bug Reports**       | <a href="https://github.com/ml-tooling/lazydocs/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+label%3Abug+sort%3Areactions-%2B1-desc+" title="Open Bug Report"><img src="https://img.shields.io/github/issues/ml-tooling/lazydocs/bug.svg?label=bug"></a>                                 |
+| 🎁&nbsp; **Feature Requests**  | <a href="https://github.com/ml-tooling/lazydocs/issues?q=is%3Aopen+is%3Aissue+label%3Afeature+sort%3Areactions-%2B1-desc" title="Open Feature Request"><img src="https://img.shields.io/github/issues/ml-tooling/lazydocs/feature.svg?label=feature"></a>                                 |
+| 👩‍💻&nbsp; **Usage Questions**   |  _tbd_ |
+| 🗯&nbsp; **General Discussion** | _tbd_ |
+| ❓&nbsp; **Other Requests** | <a href="mailto:[email protected]" title="Email ML Tooling Team"><img src="https://img.shields.io/badge/email-ML Tooling-green?logo=mail.ru&style=flat-square&logoColor=white"></a> |
 
 ## Features
 
@@ -63,18 +61,6 @@ _Use this section for advertising the most important features and advantages of
 
 _Either put the documentation here or use a deployed documentation site via mkdocs and link to the documentation._
 
-## FAQ
-
-<details>
-<summary><b>This is the example description of an faq item</b> (click to expand...)</summary>
-</details>
-
-## Known Issues
-
-<details>
-<summary><b>This is the example description of a known issue</b> (click to expand...)</summary>
-</details>
-
 ## Contributors
 
 _TODO: Add sourcerer [hall of fame](https://github.com/sourcerer-io/hall-of-fame) here._

docs/lazydocs.about.md

@@ -2,20 +2,25 @@
 <a href="../src/lazydocs/generator.py#L0"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 # <kbd>module</kbd> `lazydocs.generator`
-
+Main module for markdown generation.
 
 
 ---
 
-<a href="../src/lazydocs/generator.py#L150"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/lazydocs/generator.py#L172"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `to_md_file`
 
 ```python
-to_md_file(string: str, filename: str, out_path: str = '') → None
+to_md_file(
+    string: str,
+    filename: str,
+    out_path: str = '',
+    watermark: bool = True
+) → None
 ```
 
-Imports a module path and create an api doc file from it.
+Creates an API docs file from a provided text.
 
 
 **Args:**
@@ -25,12 +30,14 @@ Imports a module path and create an api doc file from it.
 
  - <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="../src/lazydocs/generator.py#L607"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/lazydocs/generator.py#L751"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `generate_docs`
 
@@ -41,6 +48,9 @@ generate_docs(
     src_root_path: Optional[str] = None,
     src_base_url: Optional[str] = None,
     remove_package_prefix: bool = False,
+    ignored_modules: List[str] = [],
+    overview_file: Optional[str] = None,
+    watermark: bool = True,
     validate: bool = False
 ) → None
 ```
@@ -61,19 +71,25 @@ Generates markdown documentation for provided paths based on Google-style docstr
 
  - <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="../src/lazydocs/generator.py#L214"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/lazydocs/generator.py#L247"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>class</kbd> `MarkdownAPIGenerator`
+Markdown generator class.
 
 
 
-
-<a href="../src/lazydocs/generator.py#L215"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/lazydocs/generator.py#L250"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `__init__`
 
@@ -102,7 +118,7 @@ Initializes the markdown API generator.
 
 ---
 
-<a href="../src/lazydocs/generator.py#L436"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/lazydocs/generator.py#L514"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `class2md`
 
@@ -128,7 +144,7 @@ Takes a class and creates markdown text to document its methods and variables.
 
 ---
 
-<a href="../src/lazydocs/generator.py#L289"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/lazydocs/generator.py#L339"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `doc2md`
 
@@ -152,7 +168,7 @@ Parse docstring (with getdoc) according to Google-style formatting and convert t
 
 ---
 
-<a href="../src/lazydocs/generator.py#L371"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/lazydocs/generator.py#L434"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `func2md`
 
@@ -180,7 +196,7 @@ Takes a function (or method) and generates markdown docs.
 
 ---
 
-<a href="../src/lazydocs/generator.py#L586"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/lazydocs/generator.py#L688"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `import2md`
 
@@ -206,7 +222,7 @@ Generates markdown documentation for a selected object/import.
 
 ---
 
-<a href="../src/lazydocs/generator.py#L511"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/lazydocs/generator.py#L601"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `module2md`
 
@@ -230,5 +246,21 @@ Takes an imported module object and create a Markdown string containing function
 
  - <b>`str`</b>:  Markdown documentation for selected module.
 
+---
+
+<a href="../src/lazydocs/generator.py#L708"><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.
+
+
+
+
+---
 
+_This file was automatically generated via [lazydocs](https://github.com/ml-tooling/lazydocs) on 14, Nov 2020._