I am using Ondrej's "math_dollar" extension which lets you write latex
style dollar signs embraced math expressions like $x=1$ in a sphinx
document and they get expanded into sphinx math roles. This works
fine, expect in literal code blocks like::
you can use $x=1$ for math when using math_dollar
or in the matplotlib plot directive extensions, where I do not want
dollar signs to be translated but passed literally into matplotlib for
rendering.
.. plot::
import matplotlib.pyplot as plt
fig = plt.figure()
ax = fig.add_subplot(111)
# ...snip
ax.hist(fat, 20, normed=True)
ax.text(1.0, 0.045, r'$\mu=1.05, \sigma=0.019$', fontsize=18)
plt.show()
Is there a way to detect whether we are in a literal code block, or
some other way to figure out if we are in the main body or in a rest
directive? I'd like to turn math_dollar off when inside rest
directives, or even better when inside *certain* directives.
I've attached the math_dollar extension -- thanks in advance for any help!
JDH
--
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=.
import re
def process_dollars(app, docname, source):
r"""
Replace dollar signs with backticks.
More precisely, do a regular expression search. Replace a plain
dollar sign ($) by a backtick (`). Replace an escaped dollar sign
(\$) by a dollar sign ($). Don't change a dollar sign preceded or
followed by a backtick (`$ or $`), because of strings like
"``$HOME``". Don't make any changes on lines starting with
spaces, because those are indented and hence part of a block of
code or examples.
This also doesn't replaces dollar signs enclosed in curly braces,
to avoid nested math environments, such as ::
$f(n) = 0 \text{ if $n$ is prime}$
Thus the above line would get changed to
`f(n) = 0 \text{ if $n$ is prime}`
"""
s = "\n".join(source)
if s.find("$") == -1:
return
# This searches for "$blah$" inside a pair of curly braces --
# don't change these, since they're probably coming from a nested
# math environment. So for each match, we replace it with a temporary
# string, and later on we substitute the original back.
global _data
_data = {}
def repl(matchobj):
global _data
s = matchobj.group(0)
t = "___XXX_REPL_%d___" % len(_data)
_data[t] = s
return t
s = re.sub(r"({[^{}$]*\$[^{}$]*\$[^{}]*})", repl, s)
# matches $...$
dollars = re.compile(r"(?<!\$)(?<!\\)\$([^\$]+?)\$")
# regular expression for \$
slashdollar = re.compile(r"\\\$")
s = dollars.sub(r":math:`\1`", s)
s = slashdollar.sub(r"$", s)
# change the original {...} things in:
for r in _data:
s = s.replace(r, _data[r])
# now save results in "source"
source[:] = [s]
def setup(app):
app.connect("source-read", process_dollars)
