Skip to content

Commit

Permalink
Apply automatic release changes for v0.4.6
Browse files Browse the repository at this point in the history
  • Loading branch information
@lukasmasuch @actions-user
lukasmasuch authored and actions-user committed Mar 15, 2021
1 parent 706d545 commit 32b2918
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 16 deletions.
12 changes: 6 additions & 6 deletions Pipfile.lock
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 9 additions & 9 deletions docs/lazydocs.generation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Creates an API docs file from a provided text.

---

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

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

Expand All @@ -48,7 +48,7 @@ generate_docs(
src_root_path: Optional[str] = None,
src_base_url: Optional[str] = None,
remove_package_prefix: bool = False,
ignored_modules: List[str] = [],
ignored_modules: Optional[List[str]] = None,
overview_file: Optional[str] = None,
watermark: bool = True,
validate: bool = False
Expand All @@ -74,12 +74,12 @@ 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#L424"><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#L440"><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#L427"><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#L443"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

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

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

---

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

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

Expand All @@ -131,7 +131,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#L494"><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#L510"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

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

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

---

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

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

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

---

<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#L706"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

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

Expand All @@ -207,7 +207,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#L805"><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#L821"><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
View file
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.4.4"
__version__ = "0.4.6"
# __author__
# __email__

0 comments on commit 32b2918

Please sign in to comment.