Skip to content

Commit d3814c3

Browse files
lukasmasuchactions-user
authored andcommitted
Apply automatic release changes for v0.6.0
1 parent 12291f7 commit d3814c3

16 files changed

+624
-86
lines changed

Pipfile.lock

Lines changed: 9 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/best_of.default_config.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,11 @@
1313
- **MIN_PROJECT_DESC_LENGTH**
1414
- **UP_ARROW_IMAGE**
1515
- **LATEST_CHANGES_FILE**
16+
- **ENV_LIBRARIES_API_KEY**
1617

1718
---
1819

19-
<a href="https://github.com/best-of-lists/best-of-generator/blob/main/src/best_of/default_config.py#L9"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
20+
<a href="https://github.com/best-of-lists/best-of-generator/blob/main/src/best_of/default_config.py#L12"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
2021

2122
## <kbd>function</kbd> `prepare_configuration`
2223

@@ -29,6 +30,21 @@ prepare_configuration(cfg: dict) → Dict
2930

3031

3132

33+
---
34+
35+
<a href="https://github.com/best-of-lists/best-of-generator/blob/main/src/best_of/default_config.py#L85"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
36+
37+
## <kbd>function</kbd> `prepare_categories`
38+
39+
```python
40+
prepare_categories(input_categories: dict) → OrderedDict
41+
```
42+
43+
44+
45+
46+
47+
3248

3349

3450
---

docs/best_of.generator.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
---
1212

13-
<a href="https://github.com/best-of-lists/best-of-generator/blob/main/src/best_of/generator.py#L18"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
13+
<a href="https://github.com/best-of-lists/best-of-generator/blob/main/src/best_of/generator.py#L17"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
1414

1515
## <kbd>function</kbd> `parse_projects_yaml`
1616

@@ -27,7 +27,22 @@ parse_projects_yaml(
2727

2828
---
2929

30-
<a href="https://github.com/best-of-lists/best-of-generator/blob/main/src/best_of/generator.py#L61"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
30+
<a href="https://github.com/best-of-lists/best-of-generator/blob/main/src/best_of/generator.py#L60"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
31+
32+
## <kbd>function</kbd> `load_extension_script`
33+
34+
```python
35+
load_extension_script(extension_script_path: str) → None
36+
```
37+
38+
39+
40+
41+
42+
43+
---
44+
45+
<a href="https://github.com/best-of-lists/best-of-generator/blob/main/src/best_of/generator.py#L79"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
3146

3247
## <kbd>function</kbd> `generate_markdown`
3348

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
<!-- markdownlint-disable -->
2+
3+
<a href="https://github.com/best-of-lists/best-of-generator/blob/main/src/best_of/generators/base_generator.py#L0"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
4+
5+
# <kbd>module</kbd> `best_of.generators.base_generator`
6+
7+
8+
9+
10+
11+
12+
---
13+
14+
<a href="https://github.com/best-of-lists/best-of-generator/blob/main/src/best_of/generators/base_generator.py#L8"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
15+
16+
## <kbd>class</kbd> `BaseGenerator`
17+
18+
19+
20+
21+
22+
---
23+
24+
#### <kbd>property</kbd> name
25+
26+
Returns the name of the generator.
27+
28+
29+
30+
---
31+
32+
<a href="https://github.com/best-of-lists/best-of-generator/blob/main/src/best_of/generators/base_generator.py#L15"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
33+
34+
### <kbd>method</kbd> `write_output`
35+
36+
```python
37+
write_output(
38+
categories: OrderedDict,
39+
projects: List[Dict],
40+
config: Dict,
41+
labels: list
42+
) → None
43+
```
44+
45+
Generates the markdown output and writes into files.
46+
47+
48+
49+
**Args:**
50+
51+
- <b>`categories`</b> (OrderedDict): Projects categorized into configured categories.
52+
- <b>`projects`</b> (list): List of projects.
53+
- <b>`config`</b> (Dict): Best-of configuration.
54+
- <b>`labels`</b> (list): List of avaialable labels.
55+
56+
57+
58+
59+
---
60+
61+
_This file was automatically generated via [lazydocs](https://github.com/ml-tooling/lazydocs)._

0 commit comments

Comments
 (0)