@@ -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 main branch .
58
+ The documentation sources are found in the :file: `doc/ ` directory.
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,10 +144,9 @@ 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
148
- `sentence case <https://apastyle.apa.org/style-grammar-guidelines/capitalization/sentence-case >`__ ``Upper lower `` for
149
- section titles, e.g., ``Possible hangups `` rather than ``Possible
150
- Hangups ``
147
+ Use `sentence case <https://apastyle.apa.org/style-grammar-guidelines/capitalization/sentence-case >`__
148
+ ``Upper lower `` for section titles, e.g., ``Possible hangups `` rather than
149
+ ``Possible Hangups ``.
151
150
152
151
We aim to follow the recommendations from the
153
152
`Python documentation <https://devguide.python.org/documenting/#sections >`_
@@ -348,9 +347,10 @@ Writing mathematical expressions
348
347
349
348
In most cases, you will likely want to use one of `Sphinx's builtin Math
350
349
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.)
350
+ In rare cases we want the html output to correspond exactly with what will be
351
+ generated in a Matplotlib figure. In these cases, you can use the
352
+ `matplotlib.sphinxext.mathmpl ` Sphinx extension (See also the
353
+ :doc: `../tutorials/text/mathtext ` tutorial.)
354
354
355
355
.. _writing-docstrings :
356
356
0 commit comments