Skip to content

Commit 7738970

Browse files
committed
comparing rendering methods
1 parent 9b8da51 commit 7738970

File tree

4 files changed

+113
-5
lines changed

4 files changed

+113
-5
lines changed

doc/_templates/autoclass.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{{ fullname | escape | underline }}
2+
3+
.. currentmodule:: {{ module }}
4+
5+
.. autoclass:: {{ objname }}
6+
:no-members:
7+
:show-inheritance:
8+
9+
{% if '__init__' in methods %}
10+
{% set caught_result = methods.remove('__init__') %}
11+
{% endif %}
12+
13+
{% block methods %}
14+
{% if methods %}
15+
16+
.. rubric:: Methods
17+
18+
.. autosummary::
19+
:template: autosummary.rst
20+
:toctree:
21+
:nosignatures:
22+
{% for item in methods %}
23+
~{{ name }}.{{ item }}
24+
{% endfor %}
25+
26+
{% endif %}
27+
{% endblock %}

doc/_templates/autoclass_onefile.rst

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
.. contents:: Table of Contents
2+
:depth: 2
3+
:local:
4+
:backlinks: entry
5+
:class: multicol-toc
6+
7+
{{ fullname | escape | underline }}
8+
9+
.. currentmodule:: {{ module }}
10+
11+
.. autoclass:: {{ objname }}
12+
:no-members:
13+
:show-inheritance:
14+
15+
{% if '__init__' in methods %}
16+
{% set caught_result = methods.remove('__init__') %}
17+
{% endif %}
18+
19+
{% block methods %}
20+
{% if methods %}
21+
22+
Methods
23+
^^^^^^^
24+
25+
.. autosummary::
26+
:nosignatures:
27+
{% for item in methods %}
28+
~{{ name }}.{{ item }}
29+
{% endfor %}
30+
31+
{% endif %}
32+
{% endblock %}
33+
34+
Documentation
35+
=============
36+
37+
.. autoclass:: {{ objname }}
38+
:members:
39+
:undoc-members:
40+
:inherited-members:
41+
:show-inheritance:
42+
43+
Examples
44+
========
45+
46+
.. include:: {{module}}.{{name}}.examples
47+
{% block examples %}
48+
{% if methods %}
49+
{% for item in methods %}
50+
.. include:: {{module}}.{{name}}.{{item}}.examples
51+
.. raw:: html
52+
53+
<div class="clearer"></div>
54+
{% endfor %}
55+
{% endif %}
56+
{% endblock %}
57+

doc/api/collections_api.rst

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,32 @@ collections
99
:mod:`matplotlib.collections`
1010
=============================
1111

12+
.. currentmodule:: matplotlib.collections
13+
1214
.. automodule:: matplotlib.collections
13-
:members:
14-
:undoc-members:
15-
:show-inheritance:
16-
:inherited-members:
15+
:no-members:
16+
17+
Classes
18+
-------
19+
20+
.. autosummary::
21+
:toctree: _as_gen/
22+
:template: autoclass_onefile.rst
23+
:nosignatures:
24+
25+
AsteriskPolygonCollection
26+
BrokenBarHCollection
27+
CircleCollection
28+
Collection
29+
EllipseCollection
30+
EventCollection
31+
LineCollection
32+
PatchCollection
33+
PathCollection
34+
PolyCollection
35+
QuadMesh
36+
RegularPolyCollection
37+
StarPolygonCollection
38+
TriMesh
39+
40+

doc/api/figure_api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Classes
1717

1818
.. autosummary::
1919
:toctree: _as_gen/
20-
:template: autosummary.rst
20+
:template: autoclass.rst
2121
:nosignatures:
2222

2323
AxesStack

0 commit comments

Comments
 (0)