Skip to content

Commit 976d99a

Browse files
authored
Merge pull request matplotlib#18616 from timhoffm/doc-documenting
Improve instructions for building the docs
2 parents ca45dad + ce85ed5 commit 976d99a

File tree

1 file changed

+32
-22
lines changed

1 file changed

+32
-22
lines changed

doc/devel/documenting_mpl.rst

Lines changed: 32 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -47,40 +47,50 @@ documentation built into their comments.
4747
:file:`doc/api/api_changes/`). Sphinx_ regenerates files in these
4848
directories when building documentation.
4949

50-
Installing dependencies
51-
-----------------------
50+
Setting up the doc build
51+
------------------------
5252

5353
The documentation for Matplotlib is generated from reStructuredText (ReST_)
5454
using the Sphinx_ documentation generation tool. To build the documentation
55-
you will need to (1) set up an appropriate Python environment and (2)
56-
separately install our external dependencies.
55+
you will need to
56+
57+
1. set up an appropriate Python environment
58+
2. install additional external dependencies
5759

58-
To (1) set up an appropriate Python environment for building the
59-
documentation, you should:
60+
Setting up a dedicated Python environment
61+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6062

61-
* create a clean virtual environment with no existing Matplotlib
62-
installation
63+
* create a clean virtual environment with no existing Matplotlib installation
6364
* install the Python packages required for Matplotlib
64-
* install the additional Python packages required to build the documentation
65+
* install the additional Python packages required to build the documentation.
66+
They are listed in :file:`doc-requirements.txt`, which is shown below:
6567

66-
There are several extra python packages that are needed to build the
67-
documentation. They are listed in :file:`doc-requirements.txt`, which is
68-
shown below:
68+
.. include:: ../../requirements/doc/doc-requirements.txt
69+
:literal:
70+
71+
.. note::
6972

70-
.. include:: ../../requirements/doc/doc-requirements.txt
71-
:literal:
73+
If you've already set up an
74+
:ref:`environment for Matplotlib development <installing_for_devs>`, you
75+
can reuse that and skip the first two steps.
7276

73-
For (2), the Matplotlib docs require that you:
77+
Install additional external dependencies
78+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7479

75-
* install a minimal working LaTeX distribution
76-
* install `Graphviz <http://www.graphviz.org/download>`_
77-
* install the LaTeX packages cm-super and dvipng. If your OS bundles ``TexLive``,
80+
Required:
81+
82+
* a minimal working LaTeX distribution
83+
* `Graphviz <http://www.graphviz.org/download>`_
84+
* the LaTeX packages *cm-super* and *dvipng*. If your OS bundles ``TexLive``,
7885
then often the "complete" version of the installer will automatically include
7986
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/>`_.
87+
88+
Optional, but recommended:
89+
90+
* `Inkscape <https://inkscape.org>`_
91+
* `optipng <http://optipng.sourceforge.net>`_
92+
* the font "Humor Sans" (aka the "XKCD" font), or the free alternative
93+
`Comic Neue <http://comicneue.com/>`_.
8494

8595
.. note::
8696

0 commit comments

Comments
 (0)