@@ -53,7 +53,7 @@ Installing dependencies
5353The documentation for Matplotlib is generated from reStructuredText (ReST _)
5454using the Sphinx _ documentation generation tool. To build the documentation
5555you will need to (1) set up an appropriate Python environment and (2)
56- separately install LaTeX and Graphviz .
56+ separately install our external dependencies .
5757
5858To (1) set up an appropriate Python environment for building the
5959documentation, you should:
@@ -70,16 +70,25 @@ shown below:
7070.. include :: ../../requirements/doc/doc-requirements.txt
7171 :literal:
7272
73- To (2) set up LaTeX and Graphviz dependencies you should :
73+ For (2), the Matplotlib docs require that you:
7474
7575* install a minimal working LaTeX distribution
76- * install the LaTeX packages cm-super and dvipng
7776* install `Graphviz <http://www.graphviz.org/download >`_
77+ * install the LaTeX packages cm-super and dvipng. If your OS bundles ``TexLive ``,
78+ then often the "complete" version of the installer will automatically include
79+ these packages (e.g. "texlive-full" or "texlive-all").
80+ * (suggested) install `Inkscape <https://inkscape.org >`_.
81+ * (suggested) install `optipng <http://optipng.sourceforge.net >`_.
82+ * (suggested) install the "Humor Sans" font (aka the "XKCD" font), or the free
83+ alternative `Comic Neue <http://comicneue.com/ >`_.
7884
7985.. note ::
8086
8187 The documentation will not build without LaTeX and Graphviz. These are not
82- Python packages and must be installed separately.
88+ Python packages and must be installed separately. The documentation can be
89+ built without Inkscape and optipng, but the build process will raise various
90+ warnings. If the build process warns that you are missing fonts, make sure
91+ your LaTeX distribution bundles cm-super or install it separately.
8392
8493Building the docs
8594-----------------
@@ -111,7 +120,7 @@ it, use
111120.. code-block :: sh
112121
113122 make SPHINXOPTS= html
114-
123+
115124 On Windows the arguments must be at the end of the statement:
116125
117126.. code-block :: bat
@@ -131,8 +140,8 @@ On Windows, either use the format shown above or set options as environment vari
131140
132141.. code-block :: bat
133142
134- set O = -W --keep-going -j4
135- make html
143+ set O = -W --keep-going -j4
144+ make html
136145
137146 .. _writing-rest-pages :
138147
0 commit comments