Skip to content

Commit 3a38438

Browse files
author
Víctor Terrón
committed
Mention that matplotlib must be installed before building the docs
1 parent d8221ab commit 3a38438

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

doc/README.txt

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,14 @@ for the initial run (which builds the example gallery) to be done,
3939
then run "python make.py html" again. The top file of the results will
4040
be ./build/html/index.html
4141

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

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

0 commit comments

Comments
 (0)