Skip to content

Slightly reorganize api docs. #19440

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 5, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
12 changes: 12 additions & 0 deletions doc/api/backend_gtk3_api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
**NOTE** These backends are not documented here, to avoid adding a dependency
to building the docs.

:mod:`matplotlib.backends.backend_gtk3agg`
==========================================

.. module:: matplotlib.backends.backend_gtk3agg

:mod:`matplotlib.backends.backend_gtk3cairo`
============================================

.. module:: matplotlib.backends.backend_gtk3cairo
11 changes: 0 additions & 11 deletions doc/api/backend_gtk3agg_api.rst

This file was deleted.

11 changes: 0 additions & 11 deletions doc/api/backend_gtk3cairo_api.rst

This file was deleted.

10 changes: 0 additions & 10 deletions doc/api/backend_qt4agg_api.rst

This file was deleted.

10 changes: 0 additions & 10 deletions doc/api/backend_qt4cairo_api.rst

This file was deleted.

10 changes: 0 additions & 10 deletions doc/api/backend_qt5agg_api.rst

This file was deleted.

10 changes: 0 additions & 10 deletions doc/api/backend_qt5cairo_api.rst

This file was deleted.

22 changes: 22 additions & 0 deletions doc/api/backend_qt_api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
**NOTE** These backends are not documented here, to avoid adding a dependency
to building the docs.

:mod:`matplotlib.backends.backend_qt4agg`
=========================================

.. module:: matplotlib.backends.backend_qt4agg

:mod:`matplotlib.backends.backend_qt4cairo`
===========================================

.. module:: matplotlib.backends.backend_qt4cairo

:mod:`matplotlib.backends.backend_qt5agg`
=========================================

.. module:: matplotlib.backends.backend_qt5agg

:mod:`matplotlib.backends.backend_qt5cairo`
===========================================

.. module:: matplotlib.backends.backend_qt5cairo
16 changes: 16 additions & 0 deletions doc/api/backend_tk_api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@

:mod:`matplotlib.backends.backend_tkagg`
========================================

.. automodule:: matplotlib.backends.backend_tkagg
:members:
:undoc-members:
:show-inheritance:

:mod:`matplotlib.backends.backend_tkcairo`
==========================================

.. automodule:: matplotlib.backends.backend_tkcairo
:members:
:undoc-members:
:show-inheritance:
8 changes: 0 additions & 8 deletions doc/api/backend_tkagg_api.rst

This file was deleted.

5 changes: 1 addition & 4 deletions doc/api/backend_webagg_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,4 @@
The WebAgg backend is not documented here, in order to avoid adding Tornado
to the doc build requirements.

.. .. automodule:: matplotlib.backends.backend_webagg
.. :members:
.. :undoc-members:
.. :show-inheritance:
.. module:: matplotlib.backends.backend_webagg
12 changes: 12 additions & 0 deletions doc/api/backend_wx_api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
**NOTE** These backends are not documented here, to avoid adding a dependency
to building the docs.

:mod:`matplotlib.backends.backend_wxagg`
========================================

.. module:: matplotlib.backends.backend_wxagg

:mod:`matplotlib.backends.backend_wxcairo`
==========================================

.. module:: matplotlib.backends.backend_wxcairo
10 changes: 0 additions & 10 deletions doc/api/backend_wxagg_api.rst

This file was deleted.

2 changes: 1 addition & 1 deletion doc/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@ Matplotlib consists of the following submodules:
dates_api.rst
docstring_api.rst
dviread.rst
_enums.rst
figure_api.rst
font_manager_api.rst
fontconfig_pattern_api.rst
Expand Down Expand Up @@ -128,6 +127,7 @@ Matplotlib consists of the following submodules:
units_api.rst
widgets_api.rst
_api_api.rst
_enums_api.rst

Toolkits
--------
Expand Down
12 changes: 4 additions & 8 deletions doc/api/index_backend_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,13 @@
backend_template_api.rst
backend_agg_api.rst
backend_cairo_api.rst
backend_gtk3agg_api.rst
backend_gtk3cairo_api.rst
backend_gtk3_api.rst
backend_nbagg_api.rst
backend_pdf_api.rst
backend_pgf_api.rst
backend_ps_api.rst
backend_qt4agg_api.rst
backend_qt4cairo_api.rst
backend_qt5agg_api.rst
backend_qt5cairo_api.rst
backend_qt_api.rst
backend_svg_api.rst
backend_tkagg_api.rst
backend_tk_api.rst
backend_webagg_api.rst
backend_wxagg_api.rst
backend_wx_api.rst
Loading