File tree Expand file tree Collapse file tree 1 file changed +4
-3
lines changed Expand file tree Collapse file tree 1 file changed +4
-3
lines changed Original file line number Diff line number Diff line change @@ -19,8 +19,9 @@ General file structure
19
19
----------------------
20
20
21
21
All documentation is built from the :file: `doc/ `, :file: `tutorials/ `, and
22
- :file: `examples/ ` directories. The :file: `doc/ ` directory contains configuration files for Sphinx
23
- and reStructuredText (ReST _; ``.rst ``) files that are rendered to documentation pages.
22
+ :file: `examples/ ` directories. The :file: `doc/ ` directory contains
23
+ configuration files for Sphinx and reStructuredText (ReST _; ``.rst ``) files
24
+ that are rendered to documentation pages.
24
25
25
26
26
27
The main entry point is :file: `doc/index.rst `, which pulls in the
@@ -41,7 +42,7 @@ documentation built into their comments.
41
42
42
43
.. note ::
43
44
44
- Don't directly edit the ``.rst `` files in :file: `doc/gallery `,
45
+ Don't directly edit the ``.rst `` files in :file: `doc/gallery `,
45
46
:file: `doc/tutorials `, and :file: `doc/api ` (excepting
46
47
:file: `doc/api/api_changes/ `). Sphinx _ regenerates files in these
47
48
directories when building documentation.
You can’t perform that action at this time.
0 commit comments