-
-
Notifications
You must be signed in to change notification settings - Fork 333
/
Copy pathref.jinja
45 lines (37 loc) · 1.35 KB
/
ref.jinja
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# Package Reference: `{{ groups.package[0].package }}`
{{ groups.package[0].docstring }}
{% for class_name, class_item in groups.package[0].class.items() %}
## [`{{ class_name }}` class](#{{ class_name }})
{{ class_item.docstring | safe }}
{% for method_name, method_item in class_item.method.items() %}
---
#### [`{{ method_name }}` method](#{{ method_item.ns_path }})
[*\[source\]*]({{ groups.package[0].git_url }}{{ method_item.file }}#L{{ method_item.line_num }})
```python
{{ method_name }}({{ method_item.arg_list_str | safe }})
```
{{ method_item.docstring | safe }}
{{ method_item.arg_docstring | safe }}
{% endfor %}
{% endfor %}
---
## [module functions](#{{ groups.package[0].package }}_functions)
{% for func_name, func_item in groups.package[0].function.items() %}
---
#### [`{{ func_name }}` method](#{{ func_item.ns_path }})
[*\[source\]*]({{ groups.package[0].git_url }}{{ func_item.file }}#L{{ func_item.line_num }})
```python
{{ func_name }}({{ func_item.arg_list_str | safe }})
```
{{ func_item.docstring | safe }}
{{ func_item.arg_docstring | safe }}
{% endfor %}
---
## [module types](#{{ groups.package[0].package }}_types)
{% for type_name, type_item in groups.package[0].type.items() %}
#### [`{{ type_name }}` type](#{{ type_item.ns_path }})
```python
{{ type_name }} = {{ type_item.obj | safe }}
```
{{ type_item.docstring | safe }}
{% endfor %}