Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 0696006

Browse filesBrowse files
committed
Improve the documentation guide
- Link to Sphinx reStructuredText primer. - `make show` for opening locally built docs. Closes #20552.
1 parent 450cdc6 commit 0696006
Copy full SHA for 0696006

File tree

Expand file treeCollapse file tree

1 file changed

+21
-4
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+21
-4
lines changed

‎doc/devel/documenting_mpl.rst

Copy file name to clipboardExpand all lines: doc/devel/documenting_mpl.rst
+21-4Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -103,16 +103,33 @@ On Windows, either use the format shown above or set options as environment vari
103103
set O=-W --keep-going -j4
104104
make html
105105
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+
106116
.. _writing-rest-pages:
107117

108118
Writing ReST pages
109119
==================
110120

111-
Most documentation is either in the docstring of individual
121+
Most documentation is either in the docstrings of individual
112122
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.
116133

117134
Formatting and style conventions
118135
--------------------------------

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.