Skip to content

Commit 58fade2

Browse files
committed
first pass at templates
1 parent ab4b3f5 commit 58fade2

18 files changed

+96
-502
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{{ fullname | escape | underline}}
2+
3+
.. currentmodule:: {{ module }}
4+
5+
.. auto{{ objtype }}:: {{ objname }}
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{{ objname | escape | underline}}
2+
3+
.. currentmodule:: {{ module }}
4+
5+
.. autoclass:: {{ objname }}
6+
:members:
7+
:show-inheritance:
8+
:inherited-members:
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{{ objname | escape | underline }}
2+
3+
.. currentmodule:: {{ module }}
4+
5+
.. autofunction:: {{ name }}
6+
:members:
7+
:show-inheritance:
8+
:inherited-members:

docs/source/_templates/module.rst renamed to docs/source/_templates/autosummary/module.rst

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
1-
{{ objname | escape | underline}}
1+
{{ objname | escape | underline }}
22

3-
.. automodule:: {{ objname }}
3+
.. automodule:: {{ fullname }}
4+
:members:
5+
:undoc-members:
6+
:show-inheritance:
7+
:inherited-members:
48

59
{% block attributes %}
610
{% if attributes %}
711
.. rubric:: Module Attributes
812

9-
.. autosummary::
10-
:toctree:
13+
.. autoattribute::
1114
{% for item in attributes %}
1215
{{ item }}
1316
{%- endfor %}
@@ -18,8 +21,7 @@
1821
{% if functions %}
1922
.. rubric:: {{ _('Functions') }}
2023

21-
.. autosummary::
22-
:toctree:
24+
.. autofunction::
2325
{% for item in functions %}
2426
{{ item }}
2527
{%- endfor %}
@@ -32,7 +34,6 @@
3234

3335
.. autosummary::
3436
:toctree:
35-
:template: class.rst
3637
{% for item in classes %}
3738
{{ item }}
3839
{%- endfor %}
@@ -43,8 +44,7 @@
4344
{% if exceptions %}
4445
.. rubric:: {{ _('Exceptions') }}
4546

46-
.. autosummary::
47-
:toctree:
47+
.. autoexception::
4848
{% for item in exceptions %}
4949
{{ item }}
5050
{%- endfor %}
@@ -54,10 +54,9 @@
5454
{% block modules %}
5555
{% if modules %}
5656
.. rubric:: Modules
57-
57+
5858
.. autosummary::
5959
:toctree:
60-
:template: module.rst
6160
:recursive:
6261
{% for item in modules %}
6362
{{ item }}

docs/source/_templates/class.rst

Lines changed: 0 additions & 33 deletions
This file was deleted.
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
{{ objname | escape | underline }}
2+
3+
.. automodule:: {{ fullname }}
4+
:members:
5+
:undoc-members:
6+
:show-inheritance:
7+
:inherited-members:
8+
9+
{% block attributes %}
10+
{% if attributes %}
11+
.. rubric:: Module Attributes
12+
13+
.. autoattribute::
14+
{% for item in attributes %}
15+
{{ item }}
16+
{%- endfor %}
17+
{% endif %}
18+
{% endblock %}
19+
20+
{% block functions %}
21+
{% if functions %}
22+
.. rubric:: {{ _('Functions') }}
23+
24+
.. autofunction::
25+
{% for item in functions %}
26+
{{ item }}
27+
{%- endfor %}
28+
{% endif %}
29+
{% endblock %}
30+
31+
{% block classes %}
32+
{% if classes %}
33+
.. rubric:: {{ _('Classes') }}
34+
35+
.. autoclass::
36+
{% for item in classes %}
37+
{{ item }}
38+
{%- endfor %}
39+
{% endif %}
40+
{% endblock %}
41+
42+
{% block exceptions %}
43+
{% if exceptions %}
44+
.. rubric:: {{ _('Exceptions') }}
45+
46+
.. autoexception::
47+
{% for item in exceptions %}
48+
{{ item }}
49+
{%- endfor %}
50+
{% endif %}
51+
{% endblock %}
52+
53+
{% block modules %}
54+
{% if modules %}
55+
.. rubric:: Modules
56+
57+
.. autosummary::
58+
:toctree:
59+
:recursive:
60+
{% for item in modules %}
61+
{{ item }}
62+
{%- endfor %}
63+
{% endif %}
64+
{% endblock %}

docs/source/api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ API
33

44
.. autosummary::
55
:toctree: _autosummary
6-
:template: module.rst
6+
:template: nucleus-module.rst
77
:recursive:
88

99
nucleus

docs/source/nucleus.annotation.rst

Lines changed: 0 additions & 49 deletions
This file was deleted.

docs/source/nucleus.autocurate.rst

Lines changed: 0 additions & 35 deletions
This file was deleted.

docs/source/nucleus.constants.rst

Lines changed: 0 additions & 23 deletions
This file was deleted.

0 commit comments

Comments
 (0)