Skip to content

Commit 9cb3350

Browse files
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

0 commit comments

Comments
 (0)