@@ -11,33 +11,63 @@ 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+ Files
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+ * project - about Matplotlib, e.g. mission, code of conduct, licenses, history, etc.
41+
42+ * users - the user documentation, e.g., installation, plotting tutorials,
43+ configuration tips, faq, explanations, etc.
44+
45+ * thirdpartypackages - redirect to <https://matplotlib.org/mpl-third-party/>
46+
47+ Build Folders
48+ ^^^^^^^^^^^^^
3849
3950* _static - used by the sphinx build system
4051
4152* _templates - used by the sphinx build system
4253
4354* sphinxext - Sphinx extensions for the Matplotlib docs
55+
56+ Symlinks
57+ --------
58+
59+ The symlink folders are generated automatically by sphinx-gallery during build from the
60+ documents in source path; therefore changes to these files must be made to the files in
61+ source path. These symlinked folders will appear under doc, ie `doc/tutorials`
62+
63+ +---------------+------------------------------+
64+ | symlink | source folder |
65+ +---------------+------------------------------+
66+ | tutorials | ../galleries/tutorials |
67+ +---------------+------------------------------+
68+ | plot_types | ../galleries/plot_types |
69+ +---------------+------------------------------+
70+ | gallery | ../galleries/examples |
71+ +---------------+------------------------------+
72+ | users/explain | ../galleries/ users_explain |
73+ +---------------+------------------------------+
0 commit comments