From 28eec9e475aa8343f7bbdb687ea901b633b1c2f0 Mon Sep 17 00:00:00 2001 From: Yaron de Leeuw Date: Mon, 16 Sep 2013 20:39:40 +0300 Subject: [PATCH 1/2] DOC: Add axes_api to documentation after the refactoring Recently, axes was converted from a module to a package. This adds axes_api to the doctree back. `show-inheritance` was removed because it tells the user that `Axes` `Bases: matplotlib.axes._base._AxesBase` which is not that relevant I think. This is mentioned in issue #1461 --- doc/api/axes_api.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/api/axes_api.rst b/doc/api/axes_api.rst index d8b5596c291f..5585cfe86cc8 100644 --- a/doc/api/axes_api.rst +++ b/doc/api/axes_api.rst @@ -6,8 +6,7 @@ axes :mod:`matplotlib.axes` ====================== -.. automodule:: matplotlib.axes +.. automodule:: matplotlib.axes._axes :members: :undoc-members: - :show-inheritance: From e665789cb7157ac5be64a8de2611cc0ebff5ad6d Mon Sep 17 00:00:00 2001 From: Yaron de Leeuw Date: Mon, 16 Sep 2013 22:12:54 +0300 Subject: [PATCH 2/2] DOC: changed axes_api from automodule to autoclass with automodule we had: `matplotlib.axes._axes.Axes` while with autoclass we have `matplotlib.axes.Axes` However, we must remember this documents only one class, so if classes will be added to the module, they should be added by hand. --- doc/api/axes_api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/axes_api.rst b/doc/api/axes_api.rst index 5585cfe86cc8..14883b695c24 100644 --- a/doc/api/axes_api.rst +++ b/doc/api/axes_api.rst @@ -6,7 +6,7 @@ axes :mod:`matplotlib.axes` ====================== -.. automodule:: matplotlib.axes._axes +.. autoclass:: matplotlib.axes.Axes :members: :undoc-members: