Skip to content

Commit 33cd234

Browse files
committed
Add overview docs file
1 parent f5c7903 commit 33cd234

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
2+
# API Overview
3+
4+
## Modules
5+
6+
- [`lazydocs.generator`](./lazydocs.generator.md#module-lazydocsgenerator): Main module for markdown generation.
7+
8+
## Classes
9+
10+
- [`MarkdownAPIGenerator`](./lazydocs.generator.md#class-markdownapigenerator): Markdown generator class.
11+
12+
## Functions
13+
14+
- [`generate_docs`](./lazydocs.generator.md#function-generate_docs): Generates markdown documentation for provided paths based on Google-style docstrings.
15+
- [`to_md_file`](./lazydocs.generator.md#function-to_md_file): Creates an API docs file from a provided text.
16+
17+
---
18+
19+
_This file was automatically generated via [lazydocs](https://github.com/ml-tooling/lazydocs) on 14, Nov 2020._

0 commit comments

Comments
 (0)