File tree Expand file tree Collapse file tree 1 file changed +21
-4
lines changed
Filter options
Expand file tree Collapse file tree 1 file changed +21
-4
lines changed
Original file line number Diff line number Diff line change @@ -103,16 +103,33 @@ On Windows, either use the format shown above or set options as environment vari
103
103
set O = -W --keep-going -j4
104
104
make html
105
105
106
+ Showing locally built docs
107
+ --------------------------
108
+
109
+ The built docs are available in the folder :file: `build/html `. A shortcut
110
+ for opening them in your default browser is:
111
+
112
+ .. code-block :: sh
113
+
114
+ make show
115
+
106
116
.. _writing-rest-pages :
107
117
108
118
Writing ReST pages
109
119
==================
110
120
111
- Most documentation is either in the docstring of individual
121
+ Most documentation is either in the docstrings of individual
112
122
classes and methods, in explicit ``.rst `` files, or in examples and tutorials.
113
- All of these use the ReST _ syntax. Users should look at the ReST _ documentation
114
- for a full description. But some specific hints and conventions Matplotlib
115
- uses are useful for creating documentation.
123
+ All of these use the ReST _ syntax and are processed by Sphinx _.
124
+
125
+ The `Sphinx reStructuredText Primer
126
+ <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html> `_ is
127
+ a good introduction into using ReST. More complete information is available in
128
+ the `reStructuredText reference documentation
129
+ <https://docutils.sourceforge.io/rst.html#reference-documentation> `_.
130
+
131
+ This section contains additional information and conventions how ReST is used
132
+ in the Matplotlib documentation.
116
133
117
134
Formatting and style conventions
118
135
--------------------------------
You can’t perform that action at this time.
0 commit comments