@@ -55,7 +55,7 @@ build the documentation.
55
55
Building the docs
56
56
-----------------
57
57
58
- The documentation sources are found in the :file: `doc/ ` directory in the trunk .
58
+ The documentation sources are found in the :file: `doc/ ` directory in the main branch .
59
59
The configuration file for Sphinx is :file: `doc/conf.py `. It controls which
60
60
directories Sphinx parses, how the docs are built, and how the extensions are
61
61
used. To build the documentation in html format, cd into :file: `doc/ ` and run:
@@ -144,7 +144,8 @@ are some formatting and style conventions that are used.
144
144
Section formatting
145
145
~~~~~~~~~~~~~~~~~~
146
146
147
- For everything but top-level chapters, use ``Upper lower `` for
147
+ For everything but top-level chapters, use
148
+ `sentence case <https://apastyle.apa.org/style-grammar-guidelines/capitalization/sentence-case >`__ ``Upper lower `` for
148
149
section titles, e.g., ``Possible hangups `` rather than ``Possible
149
150
Hangups ``
150
151
@@ -342,6 +343,14 @@ Note that the python script that generates the plot is referred to, rather than
342
343
any plot that is created. Sphinx-gallery will provide the correct reference
343
344
when the documentation is built.
344
345
346
+ Writing mathematical expressions
347
+ --------------------------------
348
+
349
+ In most cases, you will likely want to use one of `Sphinx's builtin Math
350
+ extensions <https://www.sphinx-doc.org/en/master/usage/extensions/math.html> `__.
351
+ However, to generate html output in documentation that will correspond to the
352
+ same output generated by Matplotlib, use the `matplotlib.sphinxext.mathmpl `
353
+ Sphinx extension (See also the :doc: `../tutorials/text/mathtext ` tutorial.)
345
354
346
355
.. _writing-docstrings :
347
356
0 commit comments