1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
Matplotlib documentation
========================
Building the documentation
--------------------------
A list of dependencies can be found in ../doc-requirements.txt.
All of these dependencies can be installed through pip::
pip install -r ../doc-requirements.txt
or conda::
conda install sphinx numpydoc ipython mock colorspacious pillow
To build the HTML documentation, type ``python make.py html`` in this
directory. The top file of the results will be ./build/html/index.html
**Note that Sphinx uses the installed version of the package to build the
documentation**: Matplotlib must be installed *before* the docs can be
generated.
You can build the documentation with several options:
* `--small` saves figures in low resolution.
* `--allowsphinxwarnings`: Don't turn Sphinx warnings into errors.
* `-n N` enables parallel build of the documentation using N process.
Organization
-------------
This is the top level build directory for the Matplotlib
documentation. All of the documentation is written using sphinx, a
python documentation system built on top of ReST. This directory contains
* users - the user documentation, e.g., plotting tutorials, configuration
tips, etc.
* devel - documentation for Matplotlib developers
* faq - frequently asked questions
* api - placeholders to automatically generate the api documentation
* mpl_toolkits - documentation of individual toolkits that ship with
Matplotlib
* make.py - the build script to build the html or PDF docs
* index.rst - the top level include document for Matplotlib docs
* conf.py - the sphinx configuration
* _static - used by the sphinx build system
* _templates - used by the sphinx build system
* sphinxext - Sphinx extensions for the mpl docs
* mpl_examples - a link to the Matplotlib examples in case any
documentation wants to literal include them
|
