@@ -10,34 +10,34 @@ Getting started
1010General file structure
1111----------------------
1212
13- All documentation is built from the :file: `doc/ `. The :file: `doc/ `
14- directory contains configuration files for Sphinx and reStructuredText
13+ All documentation is built from the :file: `doc/ `. The :file: `doc/ `
14+ directory contains configuration files for Sphinx and reStructuredText
1515(ReST _; ``.rst ``) files that are rendered to documentation pages.
1616
17- Documentation is created in three ways. First, API documentation
17+ Documentation is created in three ways. First, API documentation
1818(:file: `doc/api `) is created by Sphinx _ from
1919the docstrings of the classes in the Matplotlib library. Except for
20- :file: `doc/api/api_changes/ `, ``.rst `` files in :file: `doc/api ` are created
20+ :file: `doc/api/api_changes/ `, ``.rst `` files in :file: `doc/api ` are created
2121when the documentation is built. See :ref: `writing-docstrings ` below.
2222
23- Second, the contents of :file: `doc/plot_types `, :file: `doc/gallery ` and
24- :file: `doc/tutorials ` are generated by the `Sphinx Gallery `_ from python
25- files in :file: `plot_types/ `, :file: `examples/ ` and :file: `tutorials/ `.
26- These sources consist of python scripts that have ReST _ documentation built
27- into their comments. See :ref: `writing-examples-and-tutorials ` below.
23+ Second, the contents of :file: `doc/plot_types `, :file: `doc/gallery ` and
24+ :file: `doc/tutorials ` are generated by the `Sphinx Gallery `_ from python
25+ files in :file: `plot_types/ `, :file: `examples/ ` and :file: `tutorials/ `.
26+ These sources consist of python scripts that have ReST _ documentation built
27+ into their comments. See :ref: `writing-examples-and-tutorials ` below.
2828
29- Third, Matplotlib has narrative docs written in ReST _ in subdirectories of
30- :file: `doc/users/ `. If you would like to add new documentation that is suited
31- to an ``.rst `` file rather than a gallery or tutorial example, choose an
32- appropriate subdirectory to put it in, and add the file to the table of
33- contents of :file: `index.rst ` of the subdirectory. See
34- :ref: `writing-rest-pages ` below.
29+ Third, Matplotlib has narrative docs written in ReST _ in subdirectories of
30+ :file: `doc/users/ `. If you would like to add new documentation that is suited
31+ to an ``.rst `` file rather than a gallery or tutorial example, choose an
32+ appropriate subdirectory to put it in, and add the file to the table of
33+ contents of :file: `index.rst ` of the subdirectory. See
34+ :ref: `writing-rest-pages ` below.
3535
3636.. note ::
3737
3838 Don't directly edit the ``.rst `` files in :file: `doc/plot_types `,
39- :file: `doc/gallery `, :file: `doc/tutorials `, and :file: `doc/api `
40- (excepting :file: `doc/api/api_changes/ `). Sphinx _ regenerates
39+ :file: `doc/gallery `, :file: `doc/tutorials `, and :file: `doc/api `
40+ (excepting :file: `doc/api/api_changes/ `). Sphinx _ regenerates
4141 files in these directories when building documentation.
4242
4343Setting up the doc build
@@ -199,15 +199,15 @@ Documents can be linked with the ``:doc:`` directive:
199199
200200 See the :doc:`/users/faq/installing_faq`
201201
202- See the tutorial :doc:`/tutorials/introductory/sample_plots `
202+ See the tutorial :doc:`/tutorials/introductory/usage `
203203
204204 See the example :doc:`/gallery/lines_bars_and_markers/simple_plot`
205205
206206 will render as:
207207
208208 See the :doc: `/users/faq/installing_faq `
209209
210- See the tutorial :doc: `/tutorials/introductory/sample_plots `
210+ See the tutorial :doc: `/tutorials/introductory/usage `
211211
212212 See the example :doc: `/gallery/lines_bars_and_markers/simple_plot `
213213
@@ -1022,10 +1022,10 @@ Example:
10221022Navbar and style
10231023----------------
10241024
1025- Matplotlib has a few subprojects that share the same navbar and style, so these
1025+ Matplotlib has a few subprojects that share the same navbar and style, so these
10261026are centralized as a sphinx theme at
1027- `mpl_sphinx_theme <https://github.com/matplotlib/mpl-sphinx-theme >`_. Changes to the
1028- style or topbar should be made there to propagate across all subprojects.
1027+ `mpl_sphinx_theme <https://github.com/matplotlib/mpl-sphinx-theme >`_. Changes to the
1028+ style or topbar should be made there to propagate across all subprojects.
10291029
10301030.. TODO: Add section about uploading docs
10311031
0 commit comments