Skip to content

Commit 751d16f

Browse files
committed
Addressing reviewers' comments
1 parent 8b4fa23 commit 751d16f

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

doc/devel/documenting_mpl.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ build the documentation.
5555
Building the docs
5656
-----------------
5757

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.
5959
The configuration file for Sphinx is :file:`doc/conf.py`. It controls which
6060
directories Sphinx parses, how the docs are built, and how the extensions are
6161
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.
144144
Section formatting
145145
~~~~~~~~~~~~~~~~~~
146146

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``.
151150

152151
We aim to follow the recommendations from the
153152
`Python documentation <https://devguide.python.org/documenting/#sections>`_
@@ -348,9 +347,10 @@ Writing mathematical expressions
348347

349348
In most cases, you will likely want to use one of `Sphinx's builtin Math
350349
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.)
354354

355355
.. _writing-docstrings:
356356

galleries/users_explain/text/mathtext.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,9 @@
5858
:ref:`usetex tutorial <usetex>` for more information.
5959
6060
.. note::
61-
To generate html output in documentation that will correspond to the same
62-
output generated by ``mathext``, use the `matplotlib.sphinxext.mathmpl`
63-
Sphinx extension.
61+
To generate html output in documentation that will exactly match the output
62+
generated by ``mathext``, use the `matplotlib.sphinxext.mathmpl` Sphinx
63+
extension.
6464
6565
Subscripts and superscripts
6666
---------------------------

lib/matplotlib/sphinxext/mathmpl.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
A role and directive to display mathtext in Sphinx
33
==================================================
44
5+
The ``mathmpl`` Sphinx extension creates a mathtext image in Matplotlib and
6+
shows it in html output. Thus, it is a true and faithful representation of what
7+
you will see if you write a given LaTeX string to Matplotlib (see
8+
:doc:`../tutorials/text/mathtext`).
9+
510
.. warning::
611
In most cases, you will likely want to use one of `Sphinx's builtin Math
712
extensions
@@ -10,11 +15,6 @@
1015
render mathematical expressions, and addresses accessibility concerns that
1116
``mathmpl`` doesn't address.
1217
13-
The ``mathmpl`` Sphinx extension creates a mathtext image in Matplotlib and
14-
shows it in html output. Thus, it is a true and faithful representation of what
15-
you will see if you write a given LaTeX string to Matplotlib (see
16-
:doc:`../tutorials/text/mathtext`).
17-
1818
Mathtext may be included in two ways:
1919
2020
1. Inline, using the role::

0 commit comments

Comments
 (0)