Skip to content

Commit cbedb35

Browse files
committed
Note that we now require Sphinx 1.0
1 parent 4972fd9 commit cbedb35

File tree

2 files changed

+7
-14
lines changed

2 files changed

+7
-14
lines changed

doc/README.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ python documentation system built on top of ReST. This directory contains
3030
* mpl_examples - a link to the matplotlib examples in case any
3131
documentation wants to literal include them
3232

33-
To build the HTML documentation, install sphinx (0.5 or greater
33+
To build the HTML documentation, install sphinx (1.0 or greater
3434
required), then type "python make.py html" in this directory. Wait
3535
for the initial run (which builds the example gallery) to be done,
3636
then run "python make.py html" again. The top file of the results will

doc/devel/documenting_mpl.rst

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,12 @@ Getting started
88
===============
99

1010
The documentation for matplotlib is generated from ReStructured Text
11-
using the Sphinx_ documentation generation tool. Sphinx-0.5 or later
12-
is required. You might still run into problems, so most developers
13-
work from the sphinx source repository (Mercurial based) because it
14-
is a rapidly evolving project::
11+
using the Sphinx_ documentation generation tool. Sphinx-1.0 or later
12+
is required.
1513

16-
hg clone http://bitbucket.org/birkenfeld/sphinx/
17-
cd sphinx
18-
python setup.py install
19-
20-
.. _Sphinx: http://sphinx.pocoo.org/
21-
22-
The documentation sources are found in the :file:`doc/` directory in the trunk.
23-
To build the users guide in html format, cd into :file:`doc/` and
24-
do::
14+
The documentation sources are found in the :file:`doc/` directory in
15+
the trunk. To build the users guide in html format, cd into
16+
:file:`doc/` and do::
2517

2618
python make.py html
2719

@@ -406,3 +398,4 @@ Some helpful functions::
406398

407399
Shift region to the right
408400

401+
.. TODO: Add section about uploading docs

0 commit comments

Comments
 (0)