diff --git a/doc/api/artist_api.rst b/doc/api/artist_api.rst index cb662d6c71ca..256a026e5285 100644 --- a/doc/api/artist_api.rst +++ b/doc/api/artist_api.rst @@ -15,14 +15,6 @@ artists :undoc-members: :show-inheritance: -:mod:`matplotlib.legend` -============================= - -.. automodule:: matplotlib.legend - :members: - :undoc-members: - :show-inheritance: - :mod:`matplotlib.lines` ============================= diff --git a/doc/api/backend_agg_api.rst b/doc/api/backend_agg_api.rst new file mode 100644 index 000000000000..ca7a0484b0c2 --- /dev/null +++ b/doc/api/backend_agg_api.rst @@ -0,0 +1,8 @@ + +:mod:`matplotlib.backends.backend_agg` +======================================== + +.. automodule:: matplotlib.backends.backend_agg + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/api/backend_cairo_api.rst b/doc/api/backend_cairo_api.rst new file mode 100644 index 000000000000..2623270c6781 --- /dev/null +++ b/doc/api/backend_cairo_api.rst @@ -0,0 +1,8 @@ + +:mod:`matplotlib.backends.backend_cairo` +======================================== + +.. automodule:: matplotlib.backends.backend_cairo + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/api/backend_cocoaagg_api.rst b/doc/api/backend_cocoaagg_api.rst new file mode 100644 index 000000000000..6ebb02e3cbcb --- /dev/null +++ b/doc/api/backend_cocoaagg_api.rst @@ -0,0 +1,9 @@ + +:mod:`matplotlib.backends.backend_cocoaagg` +=========================================== +**TODO** The documents for this backend can not be generated on a non-Mac system because loading backend_cocoaagg.py requires PyObjC. + +.. .. automodule:: matplotlib.backends.backend_cocoaagg +.. :members: +.. :undoc-members: +.. :show-inheritance: diff --git a/doc/api/backend_emf_api.rst b/doc/api/backend_emf_api.rst new file mode 100644 index 000000000000..37dcd7383a86 --- /dev/null +++ b/doc/api/backend_emf_api.rst @@ -0,0 +1,8 @@ + +:mod:`matplotlib.backends.backend_emf` +====================================== + +.. automodule:: matplotlib.backends.backend_emf + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/api/backend_fltkagg_api.rst b/doc/api/backend_fltkagg_api.rst new file mode 100644 index 000000000000..3e07997d9b1d --- /dev/null +++ b/doc/api/backend_fltkagg_api.rst @@ -0,0 +1,8 @@ + +:mod:`matplotlib.backends.backend_fltkagg` +========================================== + +.. automodule:: matplotlib.backends.backend_fltkagg + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/api/backend_gdk_api.rst b/doc/api/backend_gdk_api.rst new file mode 100644 index 000000000000..8cd11fc0d4d4 --- /dev/null +++ b/doc/api/backend_gdk_api.rst @@ -0,0 +1,8 @@ + +:mod:`matplotlib.backends.backend_gdk` +======================================== + +.. automodule:: matplotlib.backends.backend_gdk + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/api/backend_gtk_api.rst b/doc/api/backend_gtk_api.rst new file mode 100644 index 000000000000..e75d0322be74 --- /dev/null +++ b/doc/api/backend_gtk_api.rst @@ -0,0 +1,8 @@ + +:mod:`matplotlib.backends.backend_gtk` +====================================== + +.. automodule:: matplotlib.backends.backend_gtk + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/api/backend_gtkcairo_api.rst b/doc/api/backend_gtkcairo_api.rst new file mode 100644 index 000000000000..91f52411796a --- /dev/null +++ b/doc/api/backend_gtkcairo_api.rst @@ -0,0 +1,8 @@ + +:mod:`matplotlib.backends.backend_gtkcairo` +=========================================== + +.. automodule:: matplotlib.backends.backend_gtkcairo + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/api/backend_macosx_api.rst b/doc/api/backend_macosx_api.rst new file mode 100644 index 000000000000..36f9ab9d3574 --- /dev/null +++ b/doc/api/backend_macosx_api.rst @@ -0,0 +1,10 @@ + +:mod:`matplotlib.backends.backend_macosx` +========================================= + +**TODO** This document currently can not be generated on a non-macosx system because loading backend_macosx.py requires PyObjC. + +.. .. automodule:: matplotlib.backends.backend_macosx +.. :members: +.. :undoc-members: +.. :show-inheritance: diff --git a/doc/api/backend_mixed_api.rst b/doc/api/backend_mixed_api.rst new file mode 100644 index 000000000000..7457f6684f94 --- /dev/null +++ b/doc/api/backend_mixed_api.rst @@ -0,0 +1,8 @@ + +:mod:`matplotlib.backends.backend_mixed` +======================================== + +.. automodule:: matplotlib.backends.backend_mixed + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/api/backend_ps_api.rst b/doc/api/backend_ps_api.rst new file mode 100644 index 000000000000..9d585be7a0ad --- /dev/null +++ b/doc/api/backend_ps_api.rst @@ -0,0 +1,8 @@ + +:mod:`matplotlib.backends.backend_ps` +===================================== + +.. automodule:: matplotlib.backends.backend_ps + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/api/backend_qt4_api.rst b/doc/api/backend_qt4_api.rst new file mode 100644 index 000000000000..2ccc1005ab44 --- /dev/null +++ b/doc/api/backend_qt4_api.rst @@ -0,0 +1,8 @@ + +:mod:`matplotlib.backends.backend_qt4` +====================================== + +.. automodule:: matplotlib.backends.backend_qt4 + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/api/backend_qt_api.rst b/doc/api/backend_qt_api.rst new file mode 100644 index 000000000000..6492917a18d0 --- /dev/null +++ b/doc/api/backend_qt_api.rst @@ -0,0 +1,8 @@ + +:mod:`matplotlib.backends.backend_qt` +======================================== + +.. automodule:: matplotlib.backends.backend_qt + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/api/backend_qtagg_api.rst b/doc/api/backend_qtagg_api.rst new file mode 100644 index 000000000000..1bb67b30e561 --- /dev/null +++ b/doc/api/backend_qtagg_api.rst @@ -0,0 +1,8 @@ + +:mod:`matplotlib.backends.backend_qtagg` +======================================== + +.. automodule:: matplotlib.backends.backend_qtagg + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/api/backend_svg_api.rst b/doc/api/backend_svg_api.rst new file mode 100644 index 000000000000..67407aa8c4b7 --- /dev/null +++ b/doc/api/backend_svg_api.rst @@ -0,0 +1,8 @@ + +:mod:`matplotlib.backends.backend_svg` +======================================== + +.. automodule:: matplotlib.backends.backend_svg + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/api/backend_tkagg_api.rst b/doc/api/backend_tkagg_api.rst new file mode 100644 index 000000000000..2a55bfe5c693 --- /dev/null +++ b/doc/api/backend_tkagg_api.rst @@ -0,0 +1,8 @@ + +:mod:`matplotlib.backends.backend_tkagg` +======================================== + +.. automodule:: matplotlib.backends.backend_tkagg + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/api/backend_wx_api.rst b/doc/api/backend_wx_api.rst new file mode 100644 index 000000000000..0366b73a8004 --- /dev/null +++ b/doc/api/backend_wx_api.rst @@ -0,0 +1,8 @@ + +:mod:`matplotlib.backends.backend_wx` +===================================== + +.. automodule:: matplotlib.backends.backend_wx + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/api/index_backend_api.rst b/doc/api/index_backend_api.rst index 8a3682630279..717383d0e9a4 100644 --- a/doc/api/index_backend_api.rst +++ b/doc/api/index_backend_api.rst @@ -2,12 +2,58 @@ backends ******** +Core +==== .. toctree:: backend_bases_api.rst + backend_agg_api.rst + backend_tkagg_api.rst + backend_mixed_api.rst + +GTK +=== +.. toctree:: + backend_gtkagg_api.rst + backend_gtk_api.rst + backend_gdk_api.rst + backend_gtkcairo_api.rst + backend_cairo_api.rst + + +QT +== +.. toctree:: + + backend_qtagg_api.rst + backend_qt_api.rst backend_qt4agg_api.rst + backend_qt4_api.rst + +WX +== +.. toctree:: + backend_wxagg_api.rst + backend_wx_api.rst + backend_fltkagg_api.rst + +OSX +=== +.. toctree:: + + backend_macosx_api.rst + backend_cocoaagg_api.rst + +File Formats and Miscellaneous +============================== +.. toctree:: + backend_pdf_api.rst + backend_ps_api.rst + backend_svg_api.rst + backend_emf_api.rst dviread.rst type1font.rst + diff --git a/lib/matplotlib/backends/backend_cairo.py b/lib/matplotlib/backends/backend_cairo.py index cb7b2f940e9f..68aa30916a74 100644 --- a/lib/matplotlib/backends/backend_cairo.py +++ b/lib/matplotlib/backends/backend_cairo.py @@ -3,14 +3,15 @@ Author: Steve Chaplin Cairo is a vector graphics library with cross-device output support. -Features of Cairo: - * anti-aliasing - * alpha channel - * saves image files as PNG, PostScript, PDF +Features of Cairo + * anti-aliasing + * alpha channel + * saves image files as PNG, PostScript, PDF http://cairographics.org -Requires (in order, all available from Cairo website): - cairo, pycairo +Requires (in order, all available from Cairo website) + * cairo + * pycairo Naming Conventions * classes MixedUpperCase diff --git a/lib/matplotlib/backends/backend_gtk.py b/lib/matplotlib/backends/backend_gtk.py index 1012bbe09423..098aef024f70 100644 --- a/lib/matplotlib/backends/backend_gtk.py +++ b/lib/matplotlib/backends/backend_gtk.py @@ -93,11 +93,11 @@ class TimerGTK(TimerBase): Subclass of :class:`backend_bases.TimerBase` that uses GTK for timer events. Attributes: - * interval: The time between timer events in milliseconds. Default + interval: The time between timer events in milliseconds. Default is 1000 ms. - * single_shot: Boolean flag indicating whether this timer should + single_shot: Boolean flag indicating whether this timer should operate as single shot (run once and then stop). Defaults to False. - * callbacks: Stores list of (func, args) tuples that will be called + callbacks: Stores list of (func, args) tuples that will be called upon timer events. This list can be manipulated directly, or the functions add_callback and remove_callback can be used. '''