diff --git a/doc/api/artist_api.rst b/doc/api/artist_api.rst index 8680be5b9f73..c8e38f88a6ca 100644 --- a/doc/api/artist_api.rst +++ b/doc/api/artist_api.rst @@ -4,7 +4,7 @@ artists ******* -.. inheritance-diagram:: matplotlib.patches matplotlib.lines matplotlib.text matplotlib.offsetbox +.. inheritance-diagram:: matplotlib.patches matplotlib.lines matplotlib.text matplotlib.offsetbox matplotlib.image :parts: 2 :mod:`matplotlib.artist` @@ -15,36 +15,3 @@ artists :undoc-members: :show-inheritance: - -:mod:`matplotlib.lines` -======================= - -.. automodule:: matplotlib.lines - :members: - :undoc-members: - :show-inheritance: - -:mod:`matplotlib.patches` -========================= - -.. automodule:: matplotlib.patches - :members: - :undoc-members: - :show-inheritance: - -:mod:`matplotlib.text` -====================== - -.. automodule:: matplotlib.text - :members: - :undoc-members: - :show-inheritance: - - -:mod:`matplotlib.offsetbox` -=========================== - -.. automodule:: matplotlib.offsetbox - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/image_api.rst b/doc/api/image_api.rst new file mode 100644 index 000000000000..15afe2e8a1b6 --- /dev/null +++ b/doc/api/image_api.rst @@ -0,0 +1,12 @@ +***** +image +***** + + +:mod:`matplotlib.image` +======================= + +.. automodule:: matplotlib.image + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/api/index.rst b/doc/api/index.rst index bf651a17d6b0..22e9671ddc4d 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -31,15 +31,20 @@ finance_api.rst font_manager_api.rst gridspec_api.rst + image_api.rst legend_api.rst + lines_api.rst markers_api.rst mathtext_api.rst mlab_api.rst + offsetbox_api.rst + patches_api.rst path_api.rst patheffects_api.rst pyplot_api.rst sankey_api.rst spines_api.rst + text_api.rst ticker_api.rst tight_layout_api.rst tri_api.rst diff --git a/doc/api/lines_api.rst b/doc/api/lines_api.rst new file mode 100644 index 000000000000..46b7a3bfe58d --- /dev/null +++ b/doc/api/lines_api.rst @@ -0,0 +1,12 @@ +***** +lines +***** + + +:mod:`matplotlib.lines` +======================= + +.. automodule:: matplotlib.lines + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/api/offsetbox_api.rst b/doc/api/offsetbox_api.rst new file mode 100644 index 000000000000..1ed7e55504db --- /dev/null +++ b/doc/api/offsetbox_api.rst @@ -0,0 +1,12 @@ +********* +offsetbox +********* + + +:mod:`matplotlib.offsetbox` +=========================== + +.. automodule:: matplotlib.offsetbox + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/api/patches_api.rst b/doc/api/patches_api.rst new file mode 100644 index 000000000000..fabd77545650 --- /dev/null +++ b/doc/api/patches_api.rst @@ -0,0 +1,12 @@ +******* +patches +******* + + +:mod:`matplotlib.patches` +========================= + +.. automodule:: matplotlib.patches + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/api/text_api.rst b/doc/api/text_api.rst new file mode 100644 index 000000000000..19ec2f8d833c --- /dev/null +++ b/doc/api/text_api.rst @@ -0,0 +1,12 @@ +**** +text +**** + + +:mod:`matplotlib.text` +======================= + +.. automodule:: matplotlib.text + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/faq/howto_faq.rst b/doc/faq/howto_faq.rst index 983b2e5f840e..c845b1fcdfcc 100644 --- a/doc/faq/howto_faq.rst +++ b/doc/faq/howto_faq.rst @@ -41,11 +41,13 @@ You can also filter on class instances:: .. _howto-supress_offset: + How to prevent ticklabels from having an offset ----------------------------------------------- The default formatter will use an offset to reduce the length of the ticklabels. To turn this feature off on a per-axis basis:: + ax.get_xaxis().get_major_formatter().set_useOffset(False) set the rcParam ``axes.formatter.useoffset``, or use a different @@ -385,6 +387,7 @@ pyplot:: .. seealso:: + :ref:`howto-webapp` for information about running matplotlib inside of a web application. @@ -581,7 +584,8 @@ enabled, you may get errors if you don't configure matplotlib for use in these environments. Most importantly, you need to decide what kinds of images you want to generate (PNG, PDF, SVG) and configure the appropriate default backend. For 99% of users, this will be the Agg -backend, which uses the C++ `antigrain `_ +backend, which uses the C++ +`antigrain `_ rendering engine to make nice PNGs. The Agg backend is also configured to recognize requests to generate other output formats (PDF, PS, EPS, SVG). The easiest way to configure matplotlib to use @@ -615,7 +619,7 @@ or by saving to a file handle:: import sys fig.savefig(sys.stdout) -Here is an example using `Pillow __. +Here is an example using `Pillow `_. First, the figure is saved to a StringIO object which is then fed to Pillow for further processing:: diff --git a/doc/faq/usage_faq.rst b/doc/faq/usage_faq.rst index d6b95700a4d2..26c00198dfcc 100644 --- a/doc/faq/usage_faq.rst +++ b/doc/faq/usage_faq.rst @@ -382,7 +382,7 @@ macosx Cocoa rendering in OSX windows is in non-interactive mode) ============ ================================================================ -.. _`Anti-Grain Geometry`: http://www.antigrain.com/ +.. _`Anti-Grain Geometry`: http://agg.sourceforge.net/antigrain.com/index.html .. _Postscript: http://en.wikipedia.org/wiki/PostScript .. _`Portable Document Format`: http://en.wikipedia.org/wiki/Portable_Document_Format .. _`Scalable Vector Graphics`: http://en.wikipedia.org/wiki/Scalable_Vector_Graphics diff --git a/doc/glossary/index.rst b/doc/glossary/index.rst index de17328cffca..c0d9809a6162 100644 --- a/doc/glossary/index.rst +++ b/doc/glossary/index.rst @@ -8,7 +8,7 @@ Glossary .. glossary:: AGG - The Anti-Grain Geometry (`Agg `_) rendering engine, capable of rendering + The Anti-Grain Geometry (`Agg `_) rendering engine, capable of rendering high-quality images Cairo diff --git a/doc/mpl_toolkits/index.rst b/doc/mpl_toolkits/index.rst index 87effe510692..370fb2d1396c 100644 --- a/doc/mpl_toolkits/index.rst +++ b/doc/mpl_toolkits/index.rst @@ -125,6 +125,7 @@ to matplotlib which changes many of the defaults to make plots some consider more attractive. .. _hl_plotting: + ################### High-Level Plotting ################### diff --git a/doc/resources/index.rst b/doc/resources/index.rst index 98dbd6f4599a..9d14e8fd63a5 100644 --- a/doc/resources/index.rst +++ b/doc/resources/index.rst @@ -35,7 +35,7 @@ * `Introduction to NumPy and Matplotlib `_ by Eric Jones -* `Anatomy of Matplotlib +* `Anatomy of Matplotlib `_ by Benjamin Root @@ -46,4 +46,7 @@ * `Matplotlib tutorial `_ by Nicolas P. Rougier +* `Anatomy of Matplotlib - IPython Notebooks + `_ + by Benjamin Root diff --git a/doc/users/github_stats.rst b/doc/users/github_stats.rst index bbaa504723ee..0345388fcdef 100644 --- a/doc/users/github_stats.rst +++ b/doc/users/github_stats.rst @@ -1,5 +1,6 @@ .. _github-stats: + Github stats ============ @@ -358,7 +359,7 @@ Pull Requests (326): * :ghpull:`1587`: Mac OS X 10.5 needs an autoreleasepool here to avoid memory leaks. Newer... * :ghpull:`1597`: new MatplotlibDeprecationWarning class (against master) * :ghpull:`1596`: new MatplotlibDeprecationWarning class (against 1.2.x) -* :ghpull:`1532`: CXX/Python2/cxx_extensions.cxx:1320: Assertion `ob_refcnt == 0' +* :ghpull:`1532`: CXX/Python2/cxx_extensions.cxx:1320: Assertion `ob_refcnt == 0` * :ghpull:`1604`: Make font_manager ignore KeyErrors for bad fonts * :ghpull:`1605`: Change printed -> pretty-printed * :ghpull:`1557`: inverting an axis shouldn't affect the autoscaling setting @@ -835,7 +836,7 @@ Issues (598): * :ghissue:`1696`: Fixed doc dependency on numpy_ext.numpydoc * :ghissue:`1665`: MEP10: adding numpydoc and activating autosummary * :ghissue:`1660`: Explain that matplotlib must be built before the HTML documentation -* :ghissue:`1693`: saving to *.eps broken on master +* :ghissue:`1693`: saving to eps broken on master * :ghissue:`1694`: fixes Issue #1693 * :ghissue:`1689`: SVG flip issue * :ghissue:`1681`: Fancy arrow tests are failing @@ -909,7 +910,7 @@ Issues (598): * :ghissue:`1587`: Mac OS X 10.5 needs an autoreleasepool here to avoid memory leaks. Newer... * :ghissue:`1597`: new MatplotlibDeprecationWarning class (against master) * :ghissue:`1596`: new MatplotlibDeprecationWarning class (against 1.2.x) -* :ghissue:`1532`: CXX/Python2/cxx_extensions.cxx:1320: Assertion `ob_refcnt == 0' +* :ghissue:`1532`: CXX/Python2/cxx_extensions.cxx:1320: Assertion `ob_refcnt == 0` * :ghissue:`1601`: invalid/misconfigured fonts cause the font manager to fail * :ghissue:`1604`: Make font_manager ignore KeyErrors for bad fonts * :ghissue:`1605`: Change printed -> pretty-printed diff --git a/doc/users/intro.rst b/doc/users/intro.rst index dc7a8df3d43b..4a99955811f7 100644 --- a/doc/users/intro.rst +++ b/doc/users/intro.rst @@ -21,7 +21,7 @@ should just work. For years, I used to use MATLAB exclusively for data analysis and visualization. MATLAB excels at making nice looking plots easy. When I began working with EEG data, I found that I needed to write -applications to interact with my data, and developed and EEG analysis +applications to interact with my data, and developed an EEG analysis application in MATLAB. As the application grew in complexity, interacting with databases, http servers, manipulating complex data structures, I began to strain against the limitations of MATLAB as a @@ -66,20 +66,21 @@ quite similar to MATLAB figure generating code API* is the set of classes that do the heavy lifting, creating and managing figures, text, lines, plots and so on (:ref:`artist-tutorial`). This is an abstract interface that knows -nothing about output. The *backends* are device dependent drawing +nothing about output. The *backends* are device-dependent drawing devices, aka renderers, that transform the frontend representation to hardcopy or a display device (:ref:`what-is-a-backend`). Example backends: PS creates `PostScript® `_ hardcopy, SVG creates `Scalable Vector Graphics `_ hardcopy, Agg creates PNG output using the high quality `Anti-Grain -Geometry `_ library that ships with -matplotlib, GTK embeds matplotlib in a `Gtk+ `_ +Geometry `_ +library that ships with matplotlib, GTK embeds matplotlib in a +`Gtk+ `_ application, GTKAgg uses the Anti-Grain renderer to create a figure -and embed it a Gtk+ application, and so on for `PDF +and embed it in a Gtk+ application, and so on for `PDF `_, `WxWidgets `_, `Tkinter -`_ etc. +`_, etc. matplotlib is used by many people in many different contexts. Some people want to automatically generate PostScript files to send diff --git a/doc/users/style_sheets.rst b/doc/users/style_sheets.rst index 563ac542c8ec..e42a69caf910 100644 --- a/doc/users/style_sheets.rst +++ b/doc/users/style_sheets.rst @@ -1,4 +1,4 @@ -.. _style-sheets +.. _style-sheets: *********************************** Customizing plots with style sheets