@@ -11,33 +11,61 @@ Organization
11
11
12
12
This is the top level build directory for the Matplotlib
13
13
documentation. All of the documentation is written using sphinx, a
14
- python documentation system built on top of ReST. This directory contains
14
+ python documentation system built on top of ReST. This directory contains the
15
+ following
15
16
16
- * users - the user documentation, e.g., installation, plotting tutorials,
17
- configuration tips, faq, explanations, etc.
17
+ Files
18
+ ^^^^^
18
19
19
- * devel - documentation for Matplotlib developers
20
+ * index.rst - the top level include document (and landing page) for the Matplotlib docs
20
21
21
- * api - placeholders to automatically generate the api documentation
22
+ * conf.py - the sphinx configuration
22
23
23
- * tutorials, plot_types, and gallery - automatically
24
- generated by sphinx-gallery from ``../tutorials``, ``../plot_types``, and
25
- ``../examples`` respectively (these are only present if docs have been
26
- built locally).
24
+ * docutils.conf - htmnl output configuration
27
25
28
- * thirdpartypackages - redirect to <https://matplotlib.org/mpl-third-party/>
26
+ * Makefile and make.bat - entry points for building the docs
29
27
30
- * mpl_toolkits - documentation of individual toolkits that ship with
31
- Matplotlib
28
+ * matplotlibrc - rcParam configuration for docs
32
29
33
- * index.rst - the top level include document for Matplotlib docs
30
+ * missing-references.json - list of known missing/broken references
34
31
35
- * conf.py - the sphinx configuration
36
32
37
- * Makefile and make.bat - entry points for building the docs
33
+ Content Folders
34
+ ^^^^^^^^^^^^^^^
35
+
36
+ * api - placeholders to automatically generate the api documentation
37
+
38
+ * devel - documentation for contributing to Matplotlib
39
+
40
+ * users - the user documentation, e.g., installation, plotting tutorials,
41
+ configuration tips, faq, explanations, etc.
42
+
43
+ * thirdpartypackages - redirect to <https://matplotlib.org/mpl-third-party/>
44
+
45
+ Build Folders
46
+ ^^^^^^^^^^^^^
38
47
39
48
* _static - used by the sphinx build system
40
49
41
50
* _templates - used by the sphinx build system
42
51
43
52
* sphinxext - Sphinx extensions for the Matplotlib docs
53
+
54
+ Symlinks
55
+ --------
56
+
57
+ These folders will appear in your local version of Matplotlib after the docs have been
58
+ built locally. sphinx-gallery generates them automatically from the documents in source
59
+ path; therefore changes to these files must be made to the files in source path.
60
+
61
+ +---------------+------------------------------+
62
+ | symlink | source folder |
63
+ +---------------+------------------------------+
64
+ | tutorials | ../galleries/tutorials |
65
+ +---------------+------------------------------+
66
+ | plot_types | ../galleries/plot_types |
67
+ +---------------+------------------------------+
68
+ | gallery | ../galleries/examples |
69
+ +---------------+------------------------------+
70
+ | users/explain | ../galleries/ users_explain |
71
+ +---------------+------------------------------+
0 commit comments