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

Skip to content

Commit 9cb3350

Browse files
tacaswelltacaswell
committed
Merge pull request matplotlib#3342 from WeatherGod/14xDocFixes
DOC : fixed links, un-nested artist API docs AGG link changed. Also fix other doc warnings
2 parents ad21989 + bdb0c3c commit 9cb3350

File tree

15 files changed

+91
-49
lines changed

15 files changed

+91
-49
lines changed

‎doc/api/artist_api.rst

Lines changed: 1 addition & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
artists
55
*******
66

7-
.. inheritance-diagram:: matplotlib.patches matplotlib.lines matplotlib.text matplotlib.offsetbox
7+
.. inheritance-diagram:: matplotlib.patches matplotlib.lines matplotlib.text matplotlib.offsetbox matplotlib.image
88
:parts: 2
99

1010
:mod:`matplotlib.artist`
@@ -15,36 +15,3 @@ artists
1515
:undoc-members:
1616
:show-inheritance:
1717

18-
19-
:mod:`matplotlib.lines`
20-
=======================
21-
22-
.. automodule:: matplotlib.lines
23-
:members:
24-
:undoc-members:
25-
:show-inheritance:
26-
27-
:mod:`matplotlib.patches`
28-
=========================
29-
30-
.. automodule:: matplotlib.patches
31-
:members:
32-
:undoc-members:
33-
:show-inheritance:
34-
35-
:mod:`matplotlib.text`
36-
======================
37-
38-
.. automodule:: matplotlib.text
39-
:members:
40-
:undoc-members:
41-
:show-inheritance:
42-
43-
44-
:mod:`matplotlib.offsetbox`
45-
===========================
46-
47-
.. automodule:: matplotlib.offsetbox
48-
:members:
49-
:undoc-members:
50-
:show-inheritance:

‎doc/api/image_api.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
*****
2+
image
3+
*****
4+
5+
6+
:mod:`matplotlib.image`
7+
=======================
8+
9+
.. automodule:: matplotlib.image
10+
:members:
11+
:undoc-members:
12+
:show-inheritance:

‎doc/api/index.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,20 @@
3131
finance_api.rst
3232
font_manager_api.rst
3333
gridspec_api.rst
34+
image_api.rst
3435
legend_api.rst
36+
lines_api.rst
3537
markers_api.rst
3638
mathtext_api.rst
3739
mlab_api.rst
40+
offsetbox_api.rst
41+
patches_api.rst
3842
path_api.rst
3943
patheffects_api.rst
4044
pyplot_api.rst
4145
sankey_api.rst
4246
spines_api.rst
47+
text_api.rst
4348
ticker_api.rst
4449
tight_layout_api.rst
4550
tri_api.rst

‎doc/api/lines_api.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
*****
2+
lines
3+
*****
4+
5+
6+
:mod:`matplotlib.lines`
7+
=======================
8+
9+
.. automodule:: matplotlib.lines
10+
:members:
11+
:undoc-members:
12+
:show-inheritance:

‎doc/api/offsetbox_api.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
*********
2+
offsetbox
3+
*********
4+
5+
6+
:mod:`matplotlib.offsetbox`
7+
===========================
8+
9+
.. automodule:: matplotlib.offsetbox
10+
:members:
11+
:undoc-members:
12+
:show-inheritance:

‎doc/api/patches_api.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
*******
2+
patches
3+
*******
4+
5+
6+
:mod:`matplotlib.patches`
7+
=========================
8+
9+
.. automodule:: matplotlib.patches
10+
:members:
11+
:undoc-members:
12+
:show-inheritance:

‎doc/api/text_api.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
****
2+
text
3+
****
4+
5+
6+
:mod:`matplotlib.text`
7+
=======================
8+
9+
.. automodule:: matplotlib.text
10+
:members:
11+
:undoc-members:
12+
:show-inheritance:

‎doc/faq/howto_faq.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,13 @@ You can also filter on class instances::
4141

4242

4343
.. _howto-supress_offset:
44+
4445
How to prevent ticklabels from having an offset
4546
-----------------------------------------------
4647
The default formatter will use an offset to reduce
4748
the length of the ticklabels. To turn this feature
4849
off on a per-axis basis::
50+
4951
ax.get_xaxis().get_major_formatter().set_useOffset(False)
5052

5153
set the rcParam ``axes.formatter.useoffset``, or use a different
@@ -385,6 +387,7 @@ pyplot::
385387

386388

387389
.. seealso::
390+
388391
:ref:`howto-webapp` for information about running matplotlib inside
389392
of a web application.
390393

@@ -581,7 +584,8 @@ enabled, you may get errors if you don't configure matplotlib for use
581584
in these environments. Most importantly, you need to decide what
582585
kinds of images you want to generate (PNG, PDF, SVG) and configure the
583586
appropriate default backend. For 99% of users, this will be the Agg
584-
backend, which uses the C++ `antigrain <http://antigrain.com>`_
587+
backend, which uses the C++
588+
`antigrain <http://agg.sourceforge.net/antigrain.com/index.html>`_
585589
rendering engine to make nice PNGs. The Agg backend is also
586590
configured to recognize requests to generate other output formats
587591
(PDF, PS, EPS, SVG). The easiest way to configure matplotlib to use
@@ -615,7 +619,7 @@ or by saving to a file handle::
615619
import sys
616620
fig.savefig(sys.stdout)
617621

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

‎doc/faq/usage_faq.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,7 @@ macosx Cocoa rendering in OSX windows
382382
is in non-interactive mode)
383383
============ ================================================================
384384

385-
.. _`Anti-Grain Geometry`: http://www.antigrain.com/
385+
.. _`Anti-Grain Geometry`: http://agg.sourceforge.net/antigrain.com/index.html
386386
.. _Postscript: http://en.wikipedia.org/wiki/PostScript
387387
.. _`Portable Document Format`: http://en.wikipedia.org/wiki/Portable_Document_Format
388388
.. _`Scalable Vector Graphics`: http://en.wikipedia.org/wiki/Scalable_Vector_Graphics

‎doc/glossary/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Glossary
88
.. glossary::
99

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

1414
Cairo

‎doc/mpl_toolkits/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@ to matplotlib which changes many of the defaults to make plots some
125125
consider more attractive.
126126

127127
.. _hl_plotting:
128+
128129
###################
129130
High-Level Plotting
130131
###################

‎doc/resources/index.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
* `Introduction to NumPy and Matplotlib
3636
<http://www.youtube.com/watch?v=3Fp1zn5ao2M&feature=plcp>`_ by Eric Jones
3737

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

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

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

‎doc/users/github_stats.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11

22
.. _github-stats:
3+
34
Github stats
45
============
56

@@ -358,7 +359,7 @@ Pull Requests (326):
358359
* :ghpull:`1587`: Mac OS X 10.5 needs an autoreleasepool here to avoid memory leaks. Newer...
359360
* :ghpull:`1597`: new MatplotlibDeprecationWarning class (against master)
360361
* :ghpull:`1596`: new MatplotlibDeprecationWarning class (against 1.2.x)
361-
* :ghpull:`1532`: CXX/Python2/cxx_extensions.cxx:1320: Assertion `ob_refcnt == 0'
362+
* :ghpull:`1532`: CXX/Python2/cxx_extensions.cxx:1320: Assertion `ob_refcnt == 0`
362363
* :ghpull:`1604`: Make font_manager ignore KeyErrors for bad fonts
363364
* :ghpull:`1605`: Change printed -> pretty-printed
364365
* :ghpull:`1557`: inverting an axis shouldn't affect the autoscaling setting
@@ -835,7 +836,7 @@ Issues (598):
835836
* :ghissue:`1696`: Fixed doc dependency on numpy_ext.numpydoc
836837
* :ghissue:`1665`: MEP10: adding numpydoc and activating autosummary
837838
* :ghissue:`1660`: Explain that matplotlib must be built before the HTML documentation
838-
* :ghissue:`1693`: saving to *.eps broken on master
839+
* :ghissue:`1693`: saving to eps broken on master
839840
* :ghissue:`1694`: fixes Issue #1693
840841
* :ghissue:`1689`: SVG flip issue
841842
* :ghissue:`1681`: Fancy arrow tests are failing
@@ -909,7 +910,7 @@ Issues (598):
909910
* :ghissue:`1587`: Mac OS X 10.5 needs an autoreleasepool here to avoid memory leaks. Newer...
910911
* :ghissue:`1597`: new MatplotlibDeprecationWarning class (against master)
911912
* :ghissue:`1596`: new MatplotlibDeprecationWarning class (against 1.2.x)
912-
* :ghissue:`1532`: CXX/Python2/cxx_extensions.cxx:1320: Assertion `ob_refcnt == 0'
913+
* :ghissue:`1532`: CXX/Python2/cxx_extensions.cxx:1320: Assertion `ob_refcnt == 0`
913914
* :ghissue:`1601`: invalid/misconfigured fonts cause the font manager to fail
914915
* :ghissue:`1604`: Make font_manager ignore KeyErrors for bad fonts
915916
* :ghissue:`1605`: Change printed -> pretty-printed

‎doc/users/intro.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ should just work.
2121
For years, I used to use MATLAB exclusively for data analysis and
2222
visualization. MATLAB excels at making nice looking plots easy. When
2323
I began working with EEG data, I found that I needed to write
24-
applications to interact with my data, and developed and EEG analysis
24+
applications to interact with my data, and developed an EEG analysis
2525
application in MATLAB. As the application grew in complexity,
2626
interacting with databases, http servers, manipulating complex data
2727
structures, I began to strain against the limitations of MATLAB as a
@@ -66,20 +66,21 @@ quite similar to MATLAB figure generating code
6666
API* is the set of classes that do the heavy lifting, creating and
6767
managing figures, text, lines, plots and so on
6868
(:ref:`artist-tutorial`). This is an abstract interface that knows
69-
nothing about output. The *backends* are device dependent drawing
69+
nothing about output. The *backends* are device-dependent drawing
7070
devices, aka renderers, that transform the frontend representation to
7171
hardcopy or a display device (:ref:`what-is-a-backend`). Example
7272
backends: PS creates `PostScript®
7373
<http://www.adobe.com/products/postscript/>`_ hardcopy, SVG
7474
creates `Scalable Vector Graphics <http://www.w3.org/Graphics/SVG/>`_
7575
hardcopy, Agg creates PNG output using the high quality `Anti-Grain
76-
Geometry <http://www.antigrain.com>`_ library that ships with
77-
matplotlib, GTK embeds matplotlib in a `Gtk+ <http://www.gtk.org/>`_
76+
Geometry <http://agg.sourceforge.net/antigrain.com/index.html>`_
77+
library that ships with matplotlib, GTK embeds matplotlib in a
78+
`Gtk+ <http://www.gtk.org/>`_
7879
application, GTKAgg uses the Anti-Grain renderer to create a figure
79-
and embed it a Gtk+ application, and so on for `PDF
80+
and embed it in a Gtk+ application, and so on for `PDF
8081
<http://www.adobe.com/products/acrobat/adobepdf.html>`_, `WxWidgets
8182
<http://www.wxpython.org/>`_, `Tkinter
82-
<http://docs.python.org/lib/module-Tkinter.html>`_ etc.
83+
<http://docs.python.org/lib/module-Tkinter.html>`_, etc.
8384

8485
matplotlib is used by many people in many different contexts. Some
8586
people want to automatically generate PostScript files to send

‎doc/users/style_sheets.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _style-sheets
1+
.. _style-sheets:
22

33
***********************************
44
Customizing plots with style sheets

0 commit comments

Comments
 (0)