source: sasmodels/sasmodels/rst2html.py @ 40a87fa

core_shell_microgelscostrafo411magnetic_modelrelease_v0.94release_v0.95ticket-1257-vesicle-productticket_1156ticket_1265_superballticket_822_more_unit_tests
Last change on this file since 40a87fa was 40a87fa, checked in by Paul Kienzle <pkienzle@…>, 6 years ago

lint and latex cleanup

  • Property mode set to 100644
File size: 4.3 KB
Line 
1r"""
2Convert a restructured text document to html.
3
4Inline math markup can uses the *math* directive, or it can use latex
5style *\$expression\$*.  Math can be rendered using simple html and
6unicode, or with mathjax.
7"""
8
9import re
10from contextlib import contextmanager
11
12from docutils.core import publish_parts
13from docutils.writers.html4css1 import HTMLTranslator
14from docutils.nodes import SkipNode
15
16
17def rst2html(rst, part="whole", math_output="html"):
18    r"""
19    Convert restructured text into simple html.
20
21    Valid *math_output* formats for formulas include:
22    - html
23    - mathml
24    - mathjax
25    See `http://docutils.sourceforge.net/docs/user/config.html#math-output`_
26    for details.
27
28    The following *part* choices are available:
29    - whole: the entire html document
30    - html_body: document division with title and contents and footer
31    - body: contents only
32
33    There are other parts, but they don't make sense alone:
34
35        subtitle, version, encoding, html_prolog, header, meta,
36        html_title, title, stylesheet, html_subtitle, html_body,
37        body, head, body_suffix, fragment, docinfo, html_head,
38        head_prefix, body_prefix, footer, body_pre_docinfo, whole
39    """
40    # Ick! mathjax doesn't work properly with math-output, and the
41    # others don't work properly with math_output!
42    if math_output == "mathjax":
43        settings = {"math_output": math_output}
44    else:
45        settings = {"math-output": math_output}
46
47    # math2html and mathml do not support \frac12
48    rst = replace_compact_fraction(rst)
49
50    # mathml, html do not support \tfrac
51    if math_output in ("mathml", "html"):
52        rst = rst.replace(r'\tfrac', r'\frac')
53
54    rst = replace_dollar(rst)
55    with suppress_html_errors():
56        parts = publish_parts(source=rst, writer_name='html',
57                              settings_overrides=settings)
58    return parts[part]
59
60@contextmanager
61def suppress_html_errors():
62    r"""
63    Context manager for keeping error reports out of the generated HTML.
64
65    Within the context, system message nodes in the docutils parse tree
66    will be ignored.  After the context, the usual behaviour will be restored.
67    """
68    visit_system_message = HTMLTranslator.visit_system_message
69    HTMLTranslator.visit_system_message = _skip_node
70    yield None
71    HTMLTranslator.visit_system_message = visit_system_message
72
73def _skip_node(self, node):
74    raise SkipNode
75
76
77_compact_fraction = re.compile(r"(\\[cdt]?frac)([0-9])([0-9])")
78def replace_compact_fraction(content):
79    r"""
80    Convert \frac12 to \frac{1}{2} for broken latex parsers
81    """
82    return _compact_fraction.sub(r"\1{\2}{\3}", content)
83
84
85_dollar = re.compile(r"(?:^|(?<=\s|[(]))[$]([^\n]*?)(?<![\\])[$](?:$|(?=\s|[.,;)\\]))")
86_notdollar = re.compile(r"\\[$]")
87def replace_dollar(content):
88    r"""
89    Convert dollar signs to inline math markup in rst.
90    """
91    content = _dollar.sub(r":math:`\1`", content)
92    content = _notdollar.sub("$", content)
93    return content
94
95
96def test_dollar():
97    """
98    Test substitution of dollar signs with equivalent RST math markup
99    """
100    assert replace_dollar(u"no dollar") == u"no dollar"
101    assert replace_dollar(u"$only$") == u":math:`only`"
102    assert replace_dollar(u"$first$ is good") == u":math:`first` is good"
103    assert replace_dollar(u"so is $last$") == u"so is :math:`last`"
104    assert replace_dollar(u"and $mid$ too") == u"and :math:`mid` too"
105    assert replace_dollar(u"$first$, $mid$, $last$") == u":math:`first`, :math:`mid`, :math:`last`"
106    assert replace_dollar(ur"dollar\$ escape") == u"dollar$ escape"
107    assert replace_dollar(ur"dollar \$escape\$ too") == u"dollar $escape$ too"
108    assert replace_dollar(u"spaces $in the$ math") == u"spaces :math:`in the` math"
109    assert replace_dollar(ur"emb\ $ed$\ ed") == ur"emb\ :math:`ed`\ ed"
110    assert replace_dollar(u"$first$a") == u"$first$a"
111    assert replace_dollar(u"a$last$") == u"a$last$"
112    assert replace_dollar(u"$37") == u"$37"
113    assert replace_dollar(u"($37)") == u"($37)"
114    assert replace_dollar(u"$37 - $43") == u"$37 - $43"
115    assert replace_dollar(u"($37, $38)") == u"($37, $38)"
116    assert replace_dollar(u"a $mid$dle a") == u"a $mid$dle a"
117    assert replace_dollar(u"a ($in parens$) a") == u"a (:math:`in parens`) a"
118    assert replace_dollar(u"a (again $in parens$) a") == u"a (again :math:`in parens`) a"
119
120if __name__ == "__main__":
121    test_dollar()
Note: See TracBrowser for help on using the repository browser.