Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit f1689bb

Browse filesBrowse files
pelsonpelson
committed
Merge pull request #3133 from tacaswell/doc_cleanup
General documentation cleanup and reference to spin-off projects.
2 parents bed37f7 + a85fd34 commit f1689bb
Copy full SHA for f1689bb

File tree

Expand file treeCollapse file tree

11 files changed

+89
-87
lines changed
Filter options
Expand file treeCollapse file tree

11 files changed

+89
-87
lines changed

‎doc/api/artist_api.rst

Copy file name to clipboardExpand all lines: doc/api/artist_api.rst
+14-5Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44
artists
55
*******
66

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

1010
:mod:`matplotlib.artist`
11-
=============================
11+
========================
1212

1313
.. automodule:: matplotlib.artist
1414
:members:
@@ -17,25 +17,34 @@ artists
1717

1818

1919
:mod:`matplotlib.lines`
20-
=============================
20+
=======================
2121

2222
.. automodule:: matplotlib.lines
2323
:members:
2424
:undoc-members:
2525
:show-inheritance:
2626

2727
:mod:`matplotlib.patches`
28-
=============================
28+
=========================
2929

3030
.. automodule:: matplotlib.patches
3131
:members:
3232
:undoc-members:
3333
:show-inheritance:
3434

3535
:mod:`matplotlib.text`
36-
=============================
36+
======================
3737

3838
.. automodule:: matplotlib.text
3939
:members:
4040
:undoc-members:
4141
:show-inheritance:
42+
43+
44+
:mod:`matplotlib.offsetbox`
45+
===========================
46+
47+
.. automodule:: matplotlib.offsetbox
48+
:members:
49+
:undoc-members:
50+
:show-inheritance:

‎doc/api/index_backend_api.rst

Copy file name to clipboardExpand all lines: doc/api/index_backend_api.rst
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ backends
99
backend_qt4agg_api.rst
1010
backend_wxagg_api.rst
1111
backend_pdf_api.rst
12-
backend_webagg.rst
12+
.. backend_webagg.rst
1313
dviread.rst
1414
type1font.rst

‎doc/api/offsetbox.rst

Copy file name to clipboardExpand all lines: doc/api/offsetbox.rst
-12Lines changed: 0 additions & 12 deletions
This file was deleted.

‎doc/api/patheffects_api.rst

Copy file name to clipboardExpand all lines: doc/api/patheffects_api.rst
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ patheffects
44

55

66
:mod:`matplotlib.patheffects`
7-
=======================
7+
=============================
88

99
.. automodule:: matplotlib.patheffects
1010
:members:

‎doc/contents.rst

Copy file name to clipboardExpand all lines: doc/contents.rst
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ Overview
2020
devel/index.rst
2121
mpl_toolkits/index.rst
2222
api/index.rst
23+
examples/index.rst
2324
glossary/index.rst
2425

2526
.. htmlonly::
26-
- `Examples <examples/index.html>`_
2727

2828
* :ref:`genindex`
2929
* :ref:`modindex`

‎doc/devel/portable_code.rst

Copy file name to clipboardExpand all lines: doc/devel/portable_code.rst
+5-5Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ recommended solutions. It is not a complete guide to Python 2 and 3
1010
compatibility.
1111

1212
Welcome to the ``__future__``
13-
-----------------------------
13+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1414

1515
The top of every `.py` file should include the following::
1616

@@ -26,7 +26,7 @@ gets used *a lot*::
2626
import six
2727

2828
Finding places to use six
29-
-------------------------
29+
^^^^^^^^^^^^^^^^^^^^^^^^^
3030

3131
The only way to make sure code works on both Python 2 and 3 is to make sure it
3232
is covered by unit tests.
@@ -41,7 +41,7 @@ The `six <http://pythonhosted.org/six/>`_ documentation serves as a
4141
good reference for the sorts of things that need to be updated.
4242

4343
The dreaded ``\u`` escapes
44-
--------------------------
44+
^^^^^^^^^^^^^^^^^^^^^^^^^^
4545

4646
When `from __future__ import unicode_literals` is used, all string
4747
literals (not preceded with a `b`) will become unicode literals.
@@ -86,7 +86,7 @@ of that and still support Python 2::
8686
'\\u'
8787

8888
Iteration
89-
---------
89+
^^^^^^^^^
9090

9191
The behavior of the methods for iterating over the items, values and
9292
keys of a dictionary has changed in Python 3. Additionally, other
@@ -111,7 +111,7 @@ Python 2 Python 3 six
111111
============================== ============================== ==============================
112112

113113
Numpy-specific things
114-
---------------------
114+
^^^^^^^^^^^^^^^^^^^^^
115115

116116
When specifying dtypes, all strings must be byte strings on Python 2
117117
and unicode strings on Python 3. The best way to handle this is to

‎doc/mpl_toolkits/index.rst

Copy file name to clipboardExpand all lines: doc/mpl_toolkits/index.rst
+57-7Lines changed: 57 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,9 @@ Toolkits are collections of application-specific functions that extend matplotli
2222

2323
.. _toolkit_basemap:
2424

25-
Basemap (*Not distributed with matplotlib*)
26-
============================================
25+
Basemap
26+
=======
27+
(*Not distributed with matplotlib*)
2728

2829
Plots data on map projections, with continental and political
2930
boundaries, see `basemap <http://matplotlib.org/basemap>`_
@@ -34,8 +35,10 @@ docs.
3435

3536

3637

37-
Cartopy (*Not distributed with matplotlib*)
38-
============================================
38+
Cartopy
39+
=======
40+
(*Not distributed with matplotlib*)
41+
3942
An alternative mapping library written for matplotlib ``v1.2`` and beyond.
4043
`Cartopy <http://scitools.org.uk/cartopy/docs/latest>`_ builds on top of
4144
matplotlib to provide object oriented map projection definitions and close
@@ -69,8 +72,9 @@ Excel. This toolkit ships with matplotlib, but requires
6972

7073
.. _toolkit_natgrid:
7174

72-
Natgrid (*Not distributed with matplotlib*)
73-
===========================================
75+
Natgrid
76+
=======
77+
(*Not distributed with matplotlib*)
7478

7579
mpl_toolkits.natgrid is an interface to natgrid C library for gridding
7680
irregularly spaced data. This requires a separate installation of the
@@ -82,7 +86,7 @@ page.
8286
.. _toolkit_mplot3d:
8387

8488
mplot3d
85-
===========
89+
=======
8690

8791
:ref:`mpl_toolkits.mplot3d <toolkit_mplot3d-index>` provides some basic 3D plotting (scatter, surf,
8892
line, mesh) tools. Not the fastest or feature complete 3D library out
@@ -101,3 +105,49 @@ ease displaying multiple images in matplotlib. The AxesGrid toolkit is
101105
distributed with matplotlib source.
102106

103107
.. image:: /_static/demo_axes_grid.png
108+
109+
.. _toolkit_mpldatacursor:
110+
111+
MplDataCursor
112+
=============
113+
(*Not distributed with matplotlib*)
114+
115+
`MplDataCursor <https://github.com/joferkington/mpldatacursor>`_ is a
116+
toolkit written by Joe Kington to provide interactive "data cursors"
117+
(clickable annotation boxes) for matplotlib.
118+
119+
.. _prettyplotlib:
120+
121+
prettyplotlib
122+
=============
123+
`prettyplotlib <olgabot.github.io/prettyplotlib>`_ is an extension
124+
to matplotlib which changes many of the defaults to make plots some
125+
consider more attractive.
126+
127+
.. _hl_plotting:
128+
###################
129+
High-Level Plotting
130+
###################
131+
132+
Several projects have started to provide a higher-level interface to
133+
matplotlib. These are independent projects.
134+
135+
.. _seaborn:
136+
137+
seaborn
138+
=======
139+
(*Not distributed with matplotlib*)
140+
141+
`seaborn <www.stanford.edu/~mwaskom/software/seaborn/>`_ is a high
142+
level interface for drawing statistical graphics with matplotlib. It
143+
aims to make visualization a central part of exploring and
144+
understanding complex datasets.
145+
146+
.. _ggplot:
147+
148+
ggplot
149+
======
150+
(*Not distributed with matplotlib*)
151+
152+
`ggplot <https://github.com/yhat/ggplot/>`_ is a port of the R ggplot2
153+
to python based on matplotlib.

‎examples/misc/developer_commit_history.py

Copy file name to clipboardExpand all lines: examples/misc/developer_commit_history.py
-45Lines changed: 0 additions & 45 deletions
This file was deleted.

‎lib/matplotlib/axes/_base.py

Copy file name to clipboardExpand all lines: lib/matplotlib/axes/_base.py
+4-4Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2622,8 +2622,8 @@ def get_xticklabels(self, minor=False, which=None):
26222622
Get the x tick labels as a list of :class:`~matplotlib.text.Text`
26232623
instances.
26242624
2625-
Parameter
2626-
---------
2625+
Parameters
2626+
----------
26272627
minor : bool
26282628
If True return the minor ticklabels,
26292629
else return the major ticklabels
@@ -2875,8 +2875,8 @@ def get_yticklabels(self, minor=False, which=None):
28752875
Get the x tick labels as a list of :class:`~matplotlib.text.Text`
28762876
instances.
28772877
2878-
Parameter
2879-
---------
2878+
Parameters
2879+
----------
28802880
minor : bool
28812881
If True return the minor ticklabels,
28822882
else return the major ticklabels

‎lib/matplotlib/axis.py

Copy file name to clipboardExpand all lines: lib/matplotlib/axis.py
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1171,8 +1171,8 @@ def get_ticklabels(self, minor=False, which=None):
11711171
Get the x tick labels as a list of :class:`~matplotlib.text.Text`
11721172
instances.
11731173
1174-
Parameter
1175-
---------
1174+
Parameters
1175+
----------
11761176
minor : bool
11771177
If True return the minor ticklabels,
11781178
else return the major ticklabels

‎lib/matplotlib/cbook.py

Copy file name to clipboardExpand all lines: lib/matplotlib/cbook.py
+4-4Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,8 @@ def new_function():
120120
obj_type : str, optional
121121
The object type being deprecated.
122122
123-
Example
124-
-------
123+
Examples
124+
--------
125125
# To warn of the deprecation of "matplotlib.name_of_module"
126126
warn_deprecated('1.4.0', name='matplotlib.name_of_module',
127127
obj_type='module')
@@ -172,8 +172,8 @@ def new_function():
172172
If True, uses a PendingDeprecationWarning instead of a
173173
DeprecationWarning.
174174
175-
Example
176-
-------
175+
Examples
176+
--------
177177
@deprecated('1.4.0')
178178
def the_function_to_deprecate():
179179
pass

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.