Skip to content

A reposting of the docfix/smalltypos pull request #134

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 17 commits into from
Jun 3, 2011
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
b5f86ab
Fix some typos in the installation docs
WeatherGod Apr 30, 2011
f75a39c
List requirements to run tests.
mdboom May 12, 2011
295beef
Fixed the release number and a link to matplotlib source code on the …
WeatherGod May 16, 2011
eafb2b0
Minor doc changes in the Figure class
WeatherGod May 19, 2011
e5f89e9
ReST-ification of the widgets.py module. This will likely not be the…
WeatherGod May 19, 2011
8b5f849
The addition of the widgets API rest file. Also restricted the API t…
WeatherGod May 19, 2011
87047c6
Minor changes and clarifications to some of the other API ReST files.
WeatherGod May 19, 2011
afacda8
Changed "spine" to "spines" in the api docs to keep consistency with …
WeatherGod May 20, 2011
01598cf
Correct misleading example in log scale docs.
WeatherGod May 20, 2011
8e41c36
I thought gtkagg was in the glossary... apparently not.
WeatherGod May 20, 2011
119ed59
Modified the generation of example index rest files so that a shorter…
WeatherGod May 21, 2011
27c010a
Adding some Fedora/RedHat tips to the installing faq.
WeatherGod May 22, 2011
533d58c
Remove double "installing from git" entries in the install faq.
WeatherGod May 22, 2011
d1d6837
Link to downloads pointed to the wrong version.
WeatherGod May 22, 2011
d9d8ef4
Clarified the contouring doc so that it is clear that the input array…
WeatherGod May 31, 2011
1e9b4f5
Fix a small typo in mlab.specgram's docstring.
May 23, 2011
6186817
Fixed errant statement recently added to the contour docs. Also remo…
WeatherGod Jun 1, 2011
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
4 changes: 2 additions & 2 deletions doc/_templates/indexsidebar.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ <h3>News</h3>
to support matplotlib development.</p>


<p>matplotlib 1.0.0 is available for <a href="https://sourceforge.net/projects/matplotlib/files/matplotlib/matplotlib-1.0/">download</a>. See <a href="{{ pathto('users/whats_new') }}">what's new</a> and tips on <a href="{{
<p>matplotlib 1.0.1 is available for <a href="https://sourceforge.net/projects/matplotlib/files/matplotlib/matplotlib-1.0.1/">download</a>. See <a href="{{ pathto('users/whats_new') }}">what's new</a> and tips on <a href="{{
pathto('users/installing') }}">installing</a>
</p>

Expand Down Expand Up @@ -64,7 +64,7 @@ <h3>Need help?</h3>
but it is a good idea to ping us on the mailing list too.</p>

<p>For details on what's new, see the detailed <a href="{{
pathto('_static/CHANGELOG', 1) }}">changelog</a> or browse the <a href="https://github.com/matplotlib/matplotlib.git">source code</a>. Anything that could
pathto('_static/CHANGELOG', 1) }}">changelog</a> or browse the <a href="https://github.com/matplotlib/matplotlib">source code</a>. Anything that could
require changes to your existing codes is logged in the <a href="{{
pathto('api/api_changes.html', 1) }}">api changes</a> file.</p>

Expand Down
6 changes: 3 additions & 3 deletions doc/api/afm_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
**************
matplotlib afm
**************
**********************************
afm (Adobe Font Metrics interface)
**********************************


:mod:`matplotlib.afm`
Expand Down
6 changes: 3 additions & 3 deletions doc/api/artist_api.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _artist-api:

*******************
matplotlib artists
*******************
*******
artists
*******

.. inheritance-diagram:: matplotlib.patches matplotlib.lines matplotlib.text
:parts: 2
Expand Down
6 changes: 3 additions & 3 deletions doc/api/axes_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
***************
matplotlib axes
***************
****
axes
****


:mod:`matplotlib.axes`
Expand Down
6 changes: 3 additions & 3 deletions doc/api/axis_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
***************
matplotlib axis
***************
****
axis
****


:mod:`matplotlib.axis`
Expand Down
6 changes: 3 additions & 3 deletions doc/api/cbook_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
****************
matplotlib cbook
****************
*****
cbook
*****


:mod:`matplotlib.cbook`
Expand Down
2 changes: 1 addition & 1 deletion doc/api/cm_api.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
*************
matplotlib cm
cm (colormap)
*************


Expand Down
6 changes: 3 additions & 3 deletions doc/api/collections_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
**********************
matplotlib collections
**********************
***********
collections
***********

.. inheritance-diagram:: matplotlib.collections
:parts: 2
Expand Down
6 changes: 3 additions & 3 deletions doc/api/colorbar_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
*******************
matplotlib colorbar
*******************
********
colorbar
********


:mod:`matplotlib.colorbar`
Expand Down
6 changes: 3 additions & 3 deletions doc/api/colors_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
*****************
matplotlib colors
*****************
******
colors
******


:mod:`matplotlib.colors`
Expand Down
6 changes: 3 additions & 3 deletions doc/api/dates_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
****************
matplotlib dates
****************
*****
dates
*****

.. inheritance-diagram:: matplotlib.dates
:parts: 1
Expand Down
6 changes: 3 additions & 3 deletions doc/api/figure_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
*****************
matplotlib figure
*****************
******
figure
******


:mod:`matplotlib.figure`
Expand Down
6 changes: 3 additions & 3 deletions doc/api/font_manager_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
***********************
matplotlib font_manager
***********************
************
font_manager
************

:mod:`matplotlib.font_manager`
==============================
Expand Down
6 changes: 3 additions & 3 deletions doc/api/gridspec_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
*******************
matplotlib gridspec
*******************
********
gridspec
********


:mod:`matplotlib.gridspec`
Expand Down
4 changes: 3 additions & 1 deletion doc/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
:Date: |today|

.. toctree::
:maxdepth: 1

api_changes.rst
matplotlib_configuration_api.rst
Expand All @@ -31,7 +32,8 @@
path_api.rst
pyplot_api.rst
nxutils_api.rst
spine_api.rst
spines_api.rst
ticker_api.rst
units_api.rst
index_backend_api.rst
widgets_api.rst
6 changes: 3 additions & 3 deletions doc/api/index_backend_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
*******************
matplotlib backends
*******************
********
backends
********

.. toctree::

Expand Down
6 changes: 3 additions & 3 deletions doc/api/mathtext_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
*******************
matplotlib mathtext
*******************
********
mathtext
********

.. inheritance-diagram:: matplotlib.mathtext
:parts: 1
Expand Down
6 changes: 3 additions & 3 deletions doc/api/matplotlib_configuration_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
************************
matplotlib configuration
************************
*************
configuration
*************


:mod:`matplotlib`
Expand Down
6 changes: 3 additions & 3 deletions doc/api/mlab_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
****************
matplotlib mlab
****************
****
mlab
****


:mod:`matplotlib.mlab`
Expand Down
11 changes: 7 additions & 4 deletions doc/api/nxutils_api.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@

*******************
matplotlib nxutils
*******************
*******
nxutils
*******

:mod:`matplotlib.nxutils`
===========================

.. automodule:: matplotlib.nxutils
:members:
:undoc-members:
:show-inheritance:

6 changes: 3 additions & 3 deletions doc/api/path_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
***************
matplotlib path
***************
****
path
****


:mod:`matplotlib.path`
Expand Down
6 changes: 3 additions & 3 deletions doc/api/pyplot_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
*****************
matplotlib pyplot
*****************
******
pyplot
******


:mod:`matplotlib.pyplot`
Expand Down
8 changes: 4 additions & 4 deletions doc/api/spine_api.rst → doc/api/spines_api.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
*****************
matplotlib spine
*****************
******
spines
******


:mod:`matplotlib.spine`
:mod:`matplotlib.spines`
========================

.. automodule:: matplotlib.spines
Expand Down
6 changes: 3 additions & 3 deletions doc/api/ticker_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
*******************
matplotlib ticker
*******************
******
ticker
******


:mod:`matplotlib.ticker`
Expand Down
6 changes: 3 additions & 3 deletions doc/api/units_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
*****************
matplotlib units
*****************
*****
units
*****


:mod:`matplotlib.units`
Expand Down
12 changes: 12 additions & 0 deletions doc/api/widgets_api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
*******
widgets
*******


:mod:`matplotlib.widgets`
=========================

.. automodule:: matplotlib.widgets
:members:
:undoc-members:
:show-inheritance:
16 changes: 16 additions & 0 deletions doc/devel/coding_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -372,6 +372,22 @@ please ignore it while we consolidate our testing to these locations.)

.. _nose: http://somethingaboutorange.com/mrl/projects/nose/

Requirements
------------

The following software is required to run the tests:

- nose_, version 0.11.1 or later

- `Python Imaging Library
<http://www.pythonware.com/products/pil/>`_ (to compare image
results)

- `Ghostscript <http://pages.cs.wisc.edu/~ghost/>`_ (to render PDF
files)

- `Inkscape <http://inkscape.org>`_ (to render SVG files)

Running the tests
-----------------

Expand Down
15 changes: 8 additions & 7 deletions doc/faq/installing_faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,12 +117,18 @@ and build and install as usual with::

sudo apt-get build-dep python-matplotlib

This does not build matplotlib, but it does get the install the
If you are on Fedora/RedHat, you can get all the dependencies
required to build matplotlib by first installing ``yum-builddep``
and then running::

su -c "yum-builddep python-matplotlib"

This does not build matplotlib, but it does get all of the
build dependencies, which will make building from source easier.


If you want to be able to follow the development branch as it changes just replace
the last step with (Make sure you have **setuptools** installed)::
the last step with (make sure you have **setuptools** installed)::

> python setupegg.py develop

Expand All @@ -138,11 +144,6 @@ setupegg.py develop` command again to compile them.
There is more information on :ref:`using git <using-git>` in
the developer docs.

Install from git
================

See :ref:`using-git`.

Backends
========

Expand Down
2 changes: 1 addition & 1 deletion doc/sphinxext/gen_rst.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ def generate_example_rst(app):
rstfile = '%s.rst'%basename
outrstfile = os.path.join(rstdir, rstfile)

fhsubdirIndex.write(' %s\n'%rstfile)
fhsubdirIndex.write(' %s <%s>\n'%(os.path.basename(basename),rstfile))

if not out_of_date(fullpath, outrstfile):
continue
Expand Down
Loading