Skip to content

Commit

Permalink
Finalize release for version 0.2.3 (#4)
Browse files Browse the repository at this point in the history
Co-authored-by: LukasMasuch <[email protected]>
  • Loading branch information
github-actions[bot] and lukasmasuch authored Nov 19, 2020
1 parent 9ab1f2b commit 1678339
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 11 deletions.
4 changes: 4 additions & 0 deletions docs/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
title: API Reference
nav:
- Overview: README.md
- ...
20 changes: 10 additions & 10 deletions docs/lazydocs.generation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Main module for markdown generation.

---

<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>
<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L182"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `to_md_file`

Expand All @@ -34,7 +34,7 @@ Creates an API docs file from a provided text.

---

<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>
<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L793"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `generate_docs`

Expand Down Expand Up @@ -71,13 +71,13 @@ Generates markdown documentation for provided paths based on Google-style docstr

---

<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>
<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L257"><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.


<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>
<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L260"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `__init__`

Expand All @@ -103,7 +103,7 @@ Initializes the markdown API generator.

---

<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>
<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L545"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `class2md`

Expand All @@ -128,7 +128,7 @@ Takes a class and creates markdown text to document its methods and variables.

---

<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>
<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L349"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `doc2md`

Expand All @@ -152,7 +152,7 @@ Parse docstring (with getdoc) according to Google-style formatting and convert t

---

<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>
<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L463"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `func2md`

Expand All @@ -178,7 +178,7 @@ Takes a function (or method) and generates markdown docs.

---

<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>
<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L726"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `import2md`

Expand All @@ -203,7 +203,7 @@ Generates markdown documentation for a selected object/import.

---

<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>
<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L639"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `module2md`

Expand All @@ -228,7 +228,7 @@ Takes an imported module object and create a Markdown string containing function

---

<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>
<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L746"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `overview2md`

Expand Down
2 changes: 1 addition & 1 deletion src/lazydocs/_about.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""Information about this library. This file will automatically changed."""

__version__ = "0.2.2"
__version__ = "0.2.3"
# __author__
# __email__

0 comments on commit 1678339

Please sign in to comment.