Skip to content

Commit 7313f0b

Browse files
committed
test automodapi
1 parent 2afeec7 commit 7313f0b

File tree

4 files changed

+27
-17
lines changed

4 files changed

+27
-17
lines changed

doc-requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@ ipywidgets
1313
numpydoc>=0.4
1414
pillow
1515
sphinx-gallery>=0.1.13
16+
sphinx-automodapi

doc/api/transformations.rst

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,15 @@
22
transformations
33
***************
44

5-
.. inheritance-diagram:: matplotlib.transforms matplotlib.path
6-
:parts: 1
7-
85
:mod:`matplotlib.transforms`
9-
=============================
6+
============================
107

118
.. automodule:: matplotlib.transforms
12-
:members: TransformNode, BboxBase, Bbox, TransformedBbox, Transform,
13-
TransformWrapper, AffineBase, Affine2DBase, Affine2D, IdentityTransform,
14-
BlendedGenericTransform, BlendedAffine2D, blended_transform_factory,
15-
CompositeGenericTransform, CompositeAffine2D,
16-
composite_transform_factory, BboxTransform, BboxTransformTo,
17-
BboxTransformFrom, ScaledTranslation, TransformedPath, nonsingular,
18-
interval_contains, interval_contains_open
19-
:show-inheritance:
9+
:no-members:
10+
:no-undoc-members:
2011

12+
.. automodapi:: matplotlib.transforms
13+
:no-main-docstr:
14+
:skip: affine_transform
15+
:skip: inv
16+
:skip: Path

doc/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
extensions = [
3030
'sphinx.ext.autodoc',
3131
'sphinx.ext.autosummary',
32+
'sphinx_automodapi.automodapi',
3233
'sphinx.ext.doctest',
3334
'sphinx.ext.inheritance_diagram',
3435
'sphinx.ext.intersphinx',
@@ -48,6 +49,8 @@
4849

4950
exclude_patterns = ['api/api_changes/*', 'users/whats_new/*']
5051

52+
automodapi_toctreedirnm = 'api/_as_gen'
53+
automodsumm_inherited_members = True
5154

5255
def _check_deps():
5356
names = {"colorspacious": 'colorspacious',

lib/matplotlib/transforms.py

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1815,7 +1815,9 @@ def to_values(self):
18151815
def matrix_from_values(a, b, c, d, e, f):
18161816
"""
18171817
(staticmethod) Create a new transformation matrix as a 3x3
1818-
numpy array of the form::
1818+
numpy array of the form:
1819+
1820+
::
18191821
18201822
a c e
18211823
b d f
@@ -1869,7 +1871,9 @@ class Affine2D(Affine2DBase):
18691871

18701872
def __init__(self, matrix=None, **kwargs):
18711873
"""
1872-
Initialize an Affine transform from a 3x3 numpy float array::
1874+
Initialize an Affine transform from a 3x3 numpy float array:
1875+
1876+
::
18731877
18741878
a c e
18751879
b d f
@@ -1894,7 +1898,9 @@ def __str__(self):
18941898
def from_values(a, b, c, d, e, f):
18951899
"""
18961900
(staticmethod) Create a new Affine2D instance from the given
1897-
values::
1901+
values:
1902+
1903+
::
18981904
18991905
a c e
19001906
b d f
@@ -1907,7 +1913,9 @@ def from_values(a, b, c, d, e, f):
19071913

19081914
def get_matrix(self):
19091915
"""
1910-
Get the underlying transformation matrix as a 3x3 numpy array::
1916+
Get the underlying transformation matrix as a 3x3 numpy array:
1917+
1918+
::
19111919
19121920
a c e
19131921
b d f
@@ -1920,7 +1928,9 @@ def get_matrix(self):
19201928

19211929
def set_matrix(self, mtx):
19221930
"""
1923-
Set the underlying transformation matrix from a 3x3 numpy array::
1931+
Set the underlying transformation matrix from a 3x3 numpy array:
1932+
1933+
::
19241934
19251935
a c e
19261936
b d f

0 commit comments

Comments
 (0)