IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Make it clear that math labels are internal.

Browse Source
This commit is contained in:
Georg Brandl 2011-09-21 10:21:22 +02:00
parent 7bc89fcaec
commit e74a5541df
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/ext/math.rst
View File

@ -63,10 +63,10 @@ further translation is necessary when building LaTeX output.
.. math:: (a + b)^2 = a^2 + 2ab + b^2 .. math:: (a + b)^2 = a^2 + 2ab + b^2
Normally, equations are not numbered. If you want your equation to get a Normally, equations are not numbered. If you want your equation to get a
number, use the ``label`` option. When given, it selects a label for the number, use the ``label`` option. When given, it selects an internal label
equation, by which it can be cross-referenced, and causes an equation number for the equation, by which it can be cross-referenced, and causes an equation
to be issued. See :rst:role:`eqref` for an example. The numbering style depends number to be issued. See :rst:role:`eqref` for an example. The numbering
on the output format. style depends on the output format.
There is also an option ``nowrap`` that prevents any wrapping of the given There is also an option ``nowrap`` that prevents any wrapping of the given
math in a math environment. When you give this option, you must make sure math in a math environment. When you give this option, you must make sure