Skip to content

Commit e532e18

Browse files
author
Víctor Terrón
committed
Explain that matplotlib must be built before the HTML documentation
Attempting to generate the HTML documentation right after cloning the repository results in a cryptic error message as one of the required files, mpl-data/matplotlibrc, is created when matplotlib is built. It seems that other people have come across this problem in the past [1], so mentioning it here might be of help to newcomers. [1] http://sourceforge.net/mailarchive/message.php?msg_id=21478615
1 parent a665710 commit e532e18

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

doc/README.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,11 @@ 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
43+
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.
46+
4247
To build a smaller version of the documentation (without
4348
high-resolution PNGs and PDF examples), type "python make.py --small
4449
html".

0 commit comments

Comments
 (0)