@@ -11,33 +11,59 @@ Organization
1111
1212This is the top level build directory for the Matplotlib
1313documentation. 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
1516
16- * users - the user documentation, e.g., installation, plotting tutorials,
17- configuration tips, faq, explanations, etc.
17+ Documents
18+ ^^^^^^^^^
1819
19- * devel - documentation for Matplotlib developers
20+ * index.rst - the top level include document (and landing page) for the Matplotlib docs
2021
21- * api - placeholders to automatically generate the api documentation
22+ * conf.py - the sphinx configuration
2223
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
2725
28- * thirdpartypackages - redirect to <https://matplotlib.org/mpl-third-party/>
26+ * Makefile and make.bat - entry points for building the docs
2927
30- * mpl_toolkits - documentation of individual toolkits that ship with
31- Matplotlib
28+ * matplotlibrc - rcParam configuration for docs
3229
33- * index.rst - the top level include document for Matplotlib docs
30+ * missing-references.json - list of known missing/broken references
3431
35- * conf.py - the sphinx configuration
3632
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+ ^^^^^^^^^^^^^
3847
3948* _static - used by the sphinx build system
4049
4150* _templates - used by the sphinx build system
4251
4352* 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+ | folder | path to source folder |
63+ +-----------+----------------------------+
64+ |tutorials | ``../galleries/tutorials`` |
65+ +-----------+----------------------------+
66+ |plot_types | ``../galleries/plot_types |
67+ +-----------+----------------------------+
68+ |gallery | ``../galleries/examples`` |
69+ +-----------+----------------------------+
0 commit comments