Skip to content

Commit

Permalink
Mention that matplotlib must be installed before building the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Víctor Terrón committed Jan 20, 2013
1 parent d8221ab commit 3a38438
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions doc/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,14 @@ for the initial run (which builds the example gallery) to be done,
then run "python make.py html" again. The top file of the results will
be ./build/html/index.html

Note that ../lib/matplotlib/mpl-data/matplotlibrc' is not version
Note that Sphinx uses the installed version of the package to build
the documentation, so matplotlib must be installed *before* the docs
can be generated. Even if that is the case, one of the files needed
to do this, '../lib/matplotlib/mpl-data/matplotlibrc', is not version
controlled, but created when matplotlib is built. This means that the
HTML documentation cannot be generated immediately after checking out
the source code: you will have to run ``python setup.py build`` first.
documentation cannot be generated immediately after checking out the
source code, even if matplotlib is installed on your system: you will
have to run ``python setup.py build`` first.

To build a smaller version of the documentation (without
high-resolution PNGs and PDF examples), type "python make.py --small
Expand Down

0 comments on commit 3a38438

Please sign in to comment.