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

math: Add math_number_all to enforce numbering all displayed math.

Browse Source
This commit is contained in:
Hong Xu 2016-01-09 16:55:56 -08:00
parent 5b92c708f8
commit 540400635a
4 changed files with 21 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/ext/math.rst
View File

@ -28,6 +28,13 @@ Keep in mind that when you put math markup in **Python docstrings** read by
:mod:`autodoc <sphinx.ext.autodoc>`, you either have to double all backslashes, :mod:`autodoc <sphinx.ext.autodoc>`, you either have to double all backslashes,
or use Python raw strings (``r"raw"``). or use Python raw strings (``r"raw"``).
:mod:`.mathbase` provides the following config values:
.. confval:: math_number_all
Set this option to ``True`` if you want all displayed math to be numbered.
The default is ``False``.
:mod:`.mathbase` defines these new markup elements: :mod:`.mathbase` defines these new markup elements:
.. rst:role:: math .. rst:role:: math

3
sphinx/ext/imgmath.py
View File

@ -242,7 +242,8 @@ def html_visit_displaymath(self, node):
if node['nowrap']: if node['nowrap']:
latex = node['latex'] latex = node['latex']
else: else:
latex = wrap_displaymath(node['latex'], None) latex = wrap_displaymath(node['latex'], None,
self.builder.config.math_number_all)
try: try:
fname, depth = render_math(self, latex) fname, depth = render_math(self, latex)
except MathExtError as exc: except MathExtError as exc:

13
sphinx/ext/mathbase.py
View File

@ -28,7 +28,7 @@ class eqref(nodes.Inline, nodes.TextElement):
pass pass
def wrap_displaymath(math, label): def wrap_displaymath(math, label, numbering):
parts = math.split('\n\n') parts = math.split('\n\n')
ret = [] ret = []
for i, part in enumerate(parts): for i, part in enumerate(parts):
@ -38,7 +38,9 @@ def wrap_displaymath(math, label):
ret.append('\\begin{split}%s\\end{split}' % part + ret.append('\\begin{split}%s\\end{split}' % part +
(label and '\\label{'+label+'}' or '')) (label and '\\label{'+label+'}' or ''))
else: else:
ret.append('\\begin{split}%s\\end{split}\\notag' % part) ret.append(r'\begin{split}%s\end{split}' % part)
if not numbering:
ret.append(r'\notag')
if not ret: if not ret:
return '' return ''
return '\\begin{gather}\n' + '\\\\'.join(ret) + '\n\\end{gather}' return '\\begin{gather}\n' + '\\\\'.join(ret) + '\n\\end{gather}'
@ -116,7 +118,8 @@ def latex_visit_displaymath(self, node):
self.body.append(node['latex']) self.body.append(node['latex'])
else: else:
label = node['label'] and node['docname'] + '-' + node['label'] or None label = node['label'] and node['docname'] + '-' + node['label'] or None
self.body.append(wrap_displaymath(node['latex'], label)) self.body.append(wrap_displaymath(node['latex'], label,
self.builder.config.math_number_all))
raise nodes.SkipNode raise nodes.SkipNode
@ -194,9 +197,10 @@ def number_equations(app, doctree, docname):
num = 0 num = 0
numbers = {} numbers = {}
for node in doctree.traverse(displaymath): for node in doctree.traverse(displaymath):
if node['label'] is not None: if node['label'] is not None or app.config.math_number_all:
num += 1 num += 1
node['number'] = num node['number'] = num
if node['label'] is not None:
numbers[node['label']] = num numbers[node['label']] = num
else: else:
node['number'] = None node['number'] = None
@ -208,6 +212,7 @@ def number_equations(app, doctree, docname):
def setup_math(app, htmlinlinevisitors, htmldisplayvisitors): def setup_math(app, htmlinlinevisitors, htmldisplayvisitors):
app.add_config_value('math_number_all', False, 'html')
app.add_node(math, override=True, app.add_node(math, override=True,
latex=(latex_visit_math, None), latex=(latex_visit_math, None),
text=(text_visit_math, None), text=(text_visit_math, None),

3
sphinx/ext/pngmath.py
View File

@ -213,7 +213,8 @@ def html_visit_displaymath(self, node):
if node['nowrap']: if node['nowrap']:
latex = node['latex'] latex = node['latex']
else: else:
latex = wrap_displaymath(node['latex'], None) latex = wrap_displaymath(node['latex'], None,
self.builder.config.math_number_all)
try: try:
fname, depth = render_math(self, latex) fname, depth = render_math(self, latex)
except MathExtError as exc: except MathExtError as exc: