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

Add :rst:role:math:numref role to refer equations (Same as :rst:role:eq)

Browse Source
This commit is contained in:
Takeshi KOMIYA
2018-07-28 19:54:56 +09:00
parent d07103fde2
commit 8e56f86383
7 changed files with 36 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
doc/usage/restructuredtext/domains.rst
View File

@@ -1325,6 +1325,25 @@ These roles are provided to refer to the described objects:
.. rst:role:: rst:dir
rst:role
.. _math-domain:
The Math Domain
---------------
The math domain (name **math**) provides the following roles::
.. rst:role:: math:numref
Role for cross-referencing equations defined by :rst:dir:`math` directive
via their label. Example::
.. math:: e^{i\pi} + 1 = 0
:label: euler
Euler's identity, equation :math:numref:`euler`, was elected one of the
most beautiful mathematical formulas.
.. versionadded:: 1.8
More domains
------------

8
doc/usage/restructuredtext/roles.rst
View File

@@ -288,13 +288,7 @@ Math
.. rst:role:: eq
Role for cross-referencing equations via their label. Example::
.. math:: e^{i\pi} + 1 = 0
:label: euler
Euler's identity, equation :eq:`euler`, was elected one of the most
beautiful mathematical formulas.
Same as :rst:role:`math:numref`.
Other semantic markup