Thanks to visit codestin.com
Credit goes to github.com

Skip to content

AGG link changed. Also fix other doc warnings #3342

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 4 commits into from
Aug 7, 2014
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
35 changes: 1 addition & 34 deletions doc/api/artist_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand All @@ -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:
12 changes: 12 additions & 0 deletions doc/api/image_api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
*****
image
*****


:mod:`matplotlib.image`
=======================

.. automodule:: matplotlib.image
:members:
:undoc-members:
:show-inheritance:
5 changes: 5 additions & 0 deletions doc/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 12 additions & 0 deletions doc/api/lines_api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
*****
lines
*****


:mod:`matplotlib.lines`
=======================

.. automodule:: matplotlib.lines
:members:
:undoc-members:
:show-inheritance:
12 changes: 12 additions & 0 deletions doc/api/offsetbox_api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
*********
offsetbox
*********


:mod:`matplotlib.offsetbox`
===========================

.. automodule:: matplotlib.offsetbox
:members:
:undoc-members:
:show-inheritance:
12 changes: 12 additions & 0 deletions doc/api/patches_api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
*******
patches
*******


:mod:`matplotlib.patches`
=========================

.. automodule:: matplotlib.patches
:members:
:undoc-members:
:show-inheritance:
12 changes: 12 additions & 0 deletions doc/api/text_api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
****
text
****


:mod:`matplotlib.text`
=======================

.. automodule:: matplotlib.text
:members:
:undoc-members:
:show-inheritance:
8 changes: 6 additions & 2 deletions doc/faq/howto_faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -385,6 +387,7 @@ pyplot::


.. seealso::

:ref:`howto-webapp` for information about running matplotlib inside
of a web application.

Expand Down Expand Up @@ -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 <http://antigrain.com>`_
backend, which uses the C++
`antigrain <http://agg.sourceforge.net/antigrain.com/index.html>`_
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
Expand Down Expand Up @@ -615,7 +619,7 @@ or by saving to a file handle::
import sys
fig.savefig(sys.stdout)

Here is an example using `Pillow <http://python-imaging.github.io/>__.
Here is an example using `Pillow <http://python-imaging.github.io/>`_.
First, the figure is saved to a StringIO object which is then fed to
Pillow for further processing::

Expand Down
2 changes: 1 addition & 1 deletion doc/faq/usage_faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/glossary/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Glossary
.. glossary::

AGG
The Anti-Grain Geometry (`Agg <http://antigrain.com>`_) rendering engine, capable of rendering
The Anti-Grain Geometry (`Agg <http://agg.sourceforge.net/antigrain.com/index.html>`_) rendering engine, capable of rendering
high-quality images

Cairo
Expand Down
1 change: 1 addition & 0 deletions doc/mpl_toolkits/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ to matplotlib which changes many of the defaults to make plots some
consider more attractive.

.. _hl_plotting:

###################
High-Level Plotting
###################
Expand Down
5 changes: 4 additions & 1 deletion doc/resources/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
* `Introduction to NumPy and Matplotlib
<http://www.youtube.com/watch?v=3Fp1zn5ao2M&feature=plcp>`_ by Eric Jones

* `Anatomy of Matplotlib
* `Anatomy of Matplotlib
<https://conference.scipy.org/scipy2013/tutorial_detail.php?id=103>`_
by Benjamin Root

Expand All @@ -46,4 +46,7 @@
* `Matplotlib tutorial <http://www.loria.fr/~rougier/teaching/matplotlib/>`_
by Nicolas P. Rougier

* `Anatomy of Matplotlib - IPython Notebooks
<https://github.com/WeatherGod/AnatomyOfMatplotlib>`_
by Benjamin Root

7 changes: 4 additions & 3 deletions doc/users/github_stats.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@

.. _github-stats:

Github stats
============

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
13 changes: 7 additions & 6 deletions doc/users/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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®
<http://www.adobe.com/products/postscript/>`_ hardcopy, SVG
creates `Scalable Vector Graphics <http://www.w3.org/Graphics/SVG/>`_
hardcopy, Agg creates PNG output using the high quality `Anti-Grain
Geometry <http://www.antigrain.com>`_ library that ships with
matplotlib, GTK embeds matplotlib in a `Gtk+ <http://www.gtk.org/>`_
Geometry <http://agg.sourceforge.net/antigrain.com/index.html>`_
library that ships with matplotlib, GTK embeds matplotlib in a
`Gtk+ <http://www.gtk.org/>`_
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
<http://www.adobe.com/products/acrobat/adobepdf.html>`_, `WxWidgets
<http://www.wxpython.org/>`_, `Tkinter
<http://docs.python.org/lib/module-Tkinter.html>`_ etc.
<http://docs.python.org/lib/module-Tkinter.html>`_, etc.

matplotlib is used by many people in many different contexts. Some
people want to automatically generate PostScript files to send
Expand Down
2 changes: 1 addition & 1 deletion doc/users/style_sheets.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _style-sheets
.. _style-sheets:

***********************************
Customizing plots with style sheets
Expand Down