8000 Add api changes and what new docs · ianthomas23/matplotlib@67bec5b · GitHub
[go: up one dir, main page]

Skip to content

Commit 67bec5b

Browse files
committed
Add api changes and what new docs
1 parent ff8b24b commit 67bec5b

File tree

4 files changed

+26
-0
lines changed

4 files changed

+26
-0
lines changed

doc/api/backend_registry_api.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
********************************
2+
``matplotlib.backends.registry``
3+
********************************
4+
5+
.. automodule:: matplotlib.backends.registry
6+
:members:
7+
:undoc-members:
8+
:show-inheritance:

doc/api/index_backend_api.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
backend_pdf_api.rst
1818
backend_pgf_api.rst
1919
backend_ps_api.rst
20+
backend_registry_api.rst
2021
backend_qt_api.rst
2122
backend_svg_api.rst
2223
backend_tk_api.rst
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
`~.rcsetup.interactive_bk`, `~.rcsetup.non_interactive_bk` and `~.rcsetup.all_backends`
2+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3+
4+
... are deprecated and replaced by
5+
:meth:`matplotlib.backends.registry.backend_registry.list_builtin`
6+
with the following arguments
7+
8+
- `matplotlib.backends.registry.BackendFilter.INTERACTIVE`
9+
- `matplotlib.backends.registry.BackendFilter.NON_INTERACTIVE`
10+
- ``None``
11+
12+
respectively.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
BackendRegistry
2+
~~~~~~~~~~~~~~~
3+
4+
New `~/.BackendRegistry` class is the single source of truth for available
5+
backends. The singleton instance is `matplotlib.backends.registry.backend_registry`.

0 commit comments

Comments
 (0)
0