8000 List the webagg_core module in the sphinx docs. · matplotlib/matplotlib@0a5be98 · GitHub
[go: up one dir, main page]
Skip to content

Commit 0a5be98

Browse files
anntzeranntzer
committed
List the webagg_core module in the sphinx docs.
1 parent 48e2891 commit 0a5be98

File tree

6 files changed

+15
-10
lines changed

6 files changed

+15
-10
lines changed

‎doc/api/backend_webagg_core_api.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
*******************************************
2+
``matplotlib.backends.backend_webagg_core``
3+
*******************************************
4+
5+
.. automodule:: matplotlib.backends.backend_webagg_core
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
@@ -20,5 +20,6 @@
2020
backend_qt_api.rst
2121
backend_svg_api.rst
2222
backend_tk_api.rst
23+
backend_webagg_core_api.rst
2324
backend_webagg_api.rst
2425
backend_wx_api.rst

‎doc/api/prev_api_changes/api_changes_2.1.0.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
296296
``NavigationToolbar2.dynamic_update``
297297
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
298298

299-
Use :meth:`.draw_idle` method on the ``Canvas`` instance instead.
299+
Use `~.FigureCanvasBase.draw_idle` method on the ``Canvas`` instance instead.
300300

301301

302302
Testing

‎lib/matplotlib/backend_bases.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1118,8 +1118,8 @@ def __init__(self, interval=None, callbacks=None):
11181118
callbacks : list[tuple[callable, tuple, dict]]
11191119
List of (func, args, kwargs) tuples that will be called upon
11201120
timer events. This list is accessible as ``timer.callbacks`` and
1121-
can be manipulated directly, or the functions `add_callback` and
1122-
`remove_callback` can be used.
1121+
can be manipulated directly, or the functions `.add_callback` and
1122+
`.remove_callback` can be used.
11231123
"""
11241124
self.callbacks = [] if callbacks is None else callbacks.copy()
11251125
# Set .interval and not ._interval to go through the property setter.
@@ -1197,7 +1197,7 @@ def remove_callback(self, func, *args, **kwargs):
11971197
of the same function registered to be called with different arguments.
11981198
This behavior is deprecated. In the future, ``*args, **kwargs`` won't
11991199
be considered anymore; to keep a specific callback removable by itself,
1200-
pass it to `add_callback` as a `functools.partial` object.
1200+
pass it to `.add_callback` as a `functools.partial` object.
12011201
"""
12021202
if args or kwargs:
12031203
_api.warn_deprecated(

‎lib/matplotlib/backends/backend_webagg.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
"""
2-
Displays Agg images in the browser, with interactivity
3-
"""
1+
"""Displays Agg images in the browser, with interactivity."""
42

53
# The WebAgg backend is divided into two modules:
64
#

‎lib/matplotlib/backends/backend_webagg_core.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
"""
2-
Displays Agg images in the browser, with interactivity
3-
"""
1+
"""Displays Agg images in the browser, with interactivity."""
42
# The WebAgg backend is divided into two modules:
53
#
64
# - `backend_webagg_core.py` contains code necessary to embed a WebAgg

0 commit comments

Comments
 (0)
0