@@ -10,34 +10,34 @@ Getting started
10
10
General file structure
11
11
----------------------
12
12
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
15
15
(ReST _; ``.rst ``) files that are rendered to documentation pages.
16
16
17
- Documentation is created in three ways. First, API documentation
17
+ Documentation is created in three ways. First, API documentation
18
18
(:file: `doc/api `) is created by Sphinx _ from
19
19
the 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
21
21
when the documentation is built. See :ref: `writing-docstrings ` below.
22
22
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.
28
28
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.
35
35
36
36
.. note ::
37
37
38
38
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
41
41
files in these directories when building documentation.
42
42
43
43
Setting up the doc build
@@ -199,15 +199,15 @@ Documents can be linked with the ``:doc:`` directive:
199
199
200
200
See the :doc:`/users/faq/installing_faq`
201
201
202
- See the tutorial :doc:`/tutorials/introductory/sample_plots `
202
+ See the tutorial :doc:`/tutorials/introductory/usage `
203
203
204
204
See the example :doc:`/gallery/lines_bars_and_markers/simple_plot`
205
205
206
206
will render as:
207
207
208
208
See the :doc: `/users/faq/installing_faq `
209
209
210
- See the tutorial :doc: `/tutorials/introductory/sample_plots `
210
+ See the tutorial :doc: `/tutorials/introductory/usage `
211
211
212
212
See the example :doc: `/gallery/lines_bars_and_markers/simple_plot `
213
213
@@ -1022,10 +1022,10 @@ Example:
1022
1022
Navbar and style
1023
1023
----------------
1024
1024
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
1026
1026
are 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.
1029
1029
1030
1030
.. TODO: Add section about uploading docs
1031
1031
0 commit comments