sphinx-math-dollar 1.2__py3-none-any.whl → 1.3__py3-none-any.whl

sphinx_math_dollar/__init__.py

@@ -1,8 +1,9 @@
+from . import _version
+__version__ = _version.get_versions()['version']
+
+
 from .math_dollar import split_dollars
 from .extension import setup, NODE_BLACKLIST
 
 __all__ = ['split_dollars', 'setup', 'NODE_BLACKLIST']
 
-from ._version import get_versions
-__version__ = get_versions()['version']
-del get_versions

sphinx_math_dollar/_version.py

@@ -1,5 +1,5 @@
 
-# This file was generated by 'versioneer.py' (0.18) from
+# This file was generated by 'versioneer.py' (0.21) from
 # revision-control system data, or from the parent directory name of an
 # unpacked source archive. Distribution tarballs contain a pre-generated copy
 # of this file.
@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2020-09-17T13:01:12-0600",
+ "date": "2026-02-05T11:06:39-0700",
  "dirty": false,
  "error": null,
- "full-revisionid": "4bae503c3da72ab25cb1edb4dc62d48be41d3b48",
- "version": "1.2"
+ "full-revisionid": "3c9592e9d1bb9ec9e3bfe9e07ed8f6468012014a",
+ "version": "1.3"
 }
 '''  # END VERSION_JSON
 

sphinx_math_dollar/extension.py

@@ -1,29 +1,52 @@
-from __future__ import print_function
+import logging
 import os
 import sys
 
-from .math_dollar import split_dollars
-
-from docutils.nodes import GenericNodeVisitor, Text, math, math_block, FixedTextElement, literal
+from docutils.nodes import (
+    FixedTextElement,
+    GenericNodeVisitor,
+    SkipNode,
+    Text,
+    literal,
+    math,
+    math_block,
+)
 from docutils.transforms import Transform
 
+from . import __version__
+from .math_dollar import split_dollars
+
 NODE_BLACKLIST = node_blacklist = (FixedTextElement, literal, math)
 
 DEBUG = bool(os.environ.get("MATH_DOLLAR_DEBUG", False))
 
+
 class MathDollarReplacer(GenericNodeVisitor):
     def default_visit(self, node):
         return node
 
+    def unknown_visit(self, node):
+        logging.warning("sphinx-math-dollar: Skipping unknown node type %s", type(node))
+        raise SkipNode
+
     def visit_Text(self, node):
         parent = node.parent
         while parent:
             if isinstance(parent, node_blacklist):
-                if DEBUG and any(i == 'math' for i, _ in split_dollars(node.rawsource)):
-                    print("sphinx-math-dollar: Skipping", node, "(node_blacklist = %s)" % (node_blacklist,), file=sys.stderr)
+                if DEBUG and any(
+                    i == "math"
+                    for i, _ in split_dollars(str(node).replace("\x00", "\\"))
+                ):
+                    print(
+                        "sphinx-math-dollar: Skipping",
+                        node,
+                        "(node_blacklist = %s)" % (node_blacklist,),
+                        file=sys.stderr,
+                    )
                 return
             parent = parent.parent
-        data = split_dollars(node.rawsource)
+        # See https://github.com/sympy/sphinx-math-dollar/issues/22
+        data = split_dollars(str(node).replace("\x00", "\\"))
         nodes = []
         has_math = False
         for typ, text in data:
@@ -35,14 +58,15 @@ class MathDollarReplacer(GenericNodeVisitor):
             elif typ == "display math":
                 has_math = True
                 new_node = math_block(text, Text(text))
-                new_node.attributes.setdefault('nowrap', False)
-                new_node.attributes.setdefault('number', None)
+                new_node.attributes.setdefault("nowrap", False)
+                new_node.attributes.setdefault("number", None)
                 nodes.append(new_node)
             else:
                 raise ValueError("Unrecognized type from split_dollars %r" % typ)
         if has_math:
             node.parent.replace(node, nodes)
 
+
 class TransformMath(Transform):
     # See http://docutils.sourceforge.net/docs/ref/transforms.html. We want it
     # to apply before things that change rawsource, since we have to use that
@@ -50,19 +74,29 @@ class TransformMath(Transform):
     # transforms are relevant here, other than SmartQuotes, so this may need
     # to be adjusted.
     default_priority = 500
+
     def apply(self, **kwargs):
         self.document.walk(MathDollarReplacer(self.document))
 
+
 def config_inited(app, config):
     global node_blacklist, DEBUG
     node_blacklist = config.math_dollar_node_blacklist
     DEBUG = config.math_dollar_debug
 
+
 def setup(app):
     app.add_transform(TransformMath)
     # We can't force a rebuild here because it will always appear different
     # since the tuple contains classes
-    app.add_config_value('math_dollar_node_blacklist', NODE_BLACKLIST, '')
-    app.add_config_value('math_dollar_debug', DEBUG, '')
+    app.add_config_value("math_dollar_node_blacklist", NODE_BLACKLIST, "")
+    app.add_config_value("math_dollar_debug", DEBUG, "")
+    app.add_config_value("parallel_read_safe", True, "")
+
+    app.connect("config-inited", config_inited)
 
-    app.connect('config-inited', config_inited)
+    return {
+        "version": __version__,
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+    }

{sphinx_math_dollar-1.2.dist-info → sphinx_math_dollar-1.3.dist-info}/METADATA

@@ -1,24 +1,37 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: sphinx-math-dollar
-Version: 1.2
+Version: 1.3
 Summary: Sphinx extension to let you write LaTeX math using $$
 Home-page: https://github.com/sympy/sphinx-math-dollar/
 Author: SymPy Development Team
 Author-email: sympy@googlegroups.com
 License: MIT
-Platform: UNKNOWN
-Classifier: Programming Language :: Python :: 2
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
 License-File: LICENSE
 Requires-Dist: sphinx
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 ====================
  sphinx-math-dollar
 ====================
 
-sphinx-math-dollar is a Sphinx extension to let you write LaTeX math using $$.
+sphinx-math-dollar is a Sphinx extension to let you write LaTeX math in RST using $$.
 
 To enable install it
 
@@ -45,6 +58,13 @@ Then in your ``conf.py``, add ``'sphinx_math_dollar'`` to your extensions list:
        },
    }
 
+   mathjax3_config = {
+     "tex": {
+       "inlineMath": [['\\(', '\\)']],
+       "displayMath": [["\\[", "\\]"]],
+     }
+   }
+
 
 The ``mathjax_config`` is needed to prevent MathJax from parsing dollar signs
 which are ignored by the extension because they should not be parsed as math.
@@ -99,9 +119,34 @@ To debug which nodes are skipped, set the environment variable
 If you feel a node should always be part of the default blacklist, please make
 a `pull request <https://github.com/sympy/sphinx-math-dollar>`_.
 
+Known Issues
+============
+
+See `the issue tracker <https://github.com/sympy/sphinx-math-dollar/issues>`__
+for a full list of known issues.
+
+- Absolute values can produce errors like ``Inline substitution_reference
+  start-string without end-string.``. See `issue #16
+  <https://github.com/sympy/sphinx-math-dollar/issues/16>`__.
+
+  This is because Sphinx parses the vertical bars ``|x|`` as inline
+  substitutions. To work around this, add spaces around the absolute value
+  bars, like ``1 + | x | + y``. If an absolute value bar is at the beginning
+  or end of the math expression, use curly braces (to avoid false positives,
+  sphinx-math-dollar will not parse dollar signs as math if there is a space
+  after the first ``$`` or before the last ``$``). For example, replace ``$|y|
+  \geq |x^e|$`` with ``${ | y | \geq | x^e | }$``, which produces ${ | y |
+  \geq | x^e | }$.
+
+Markdown
+========
+
+sphinx-math-dollar is designed to work with RST, which does not natively
+support dollar signs for LaTeX math. If you prefer Markdown, we recommend
+using [MyST](https://myst-parser.readthedocs.io/en/latest/), which natively
+supports dollar math (this extension is not required).
+
 License
 =======
 
 MIT.
-
-

sphinx_math_dollar-1.3.dist-info/RECORD

@@ -0,0 +1,9 @@
+sphinx_math_dollar/__init__.py,sha256=bcmHii2PByvYXutrk_eIiiS8qMcyGmTVX4GZ2jXSPUI,215
+sphinx_math_dollar/_version.py,sha256=jXLvGiXyKsKE_dAK7b4rd_IR0bn5NOZ3U0rEgNd2tTI,495
+sphinx_math_dollar/extension.py,sha256=XUMt7auTPcJTf4ZbLt0Yik2yUpjUVidzzUwSRQbmxwE,3299
+sphinx_math_dollar/math_dollar.py,sha256=nEThpznw83f1GfCYvOyVaPUMOhA1bZBn_KR8W5cgEGY,2609
+sphinx_math_dollar-1.3.dist-info/licenses/LICENSE,sha256=vzfYNl5zzbBlGs990eAErxdU5hhaq5AjfVy5bkW58_c,1071
+sphinx_math_dollar-1.3.dist-info/METADATA,sha256=d9kUC_5EsezivSkU6mpBOEG9lxDvi4oMLfOynUcuP0c,4939
+sphinx_math_dollar-1.3.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+sphinx_math_dollar-1.3.dist-info/top_level.txt,sha256=P68HuyABkdfqVE9nYxjqUxClEj1MMo-9KMv5Iwl5wVw,19
+sphinx_math_dollar-1.3.dist-info/RECORD,,

{sphinx_math_dollar-1.2.dist-info → sphinx_math_dollar-1.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.37.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

sphinx_math_dollar/tests/test_extension.py

@@ -1,28 +0,0 @@
-import os
-
-from sphinx_testing import with_app
-
-@with_app(buildername='html', srcdir=os.path.join(os.path.dirname(__file__), 'test-build'),
-          copy_srcdir_to_tmpdir=True)
-def _test_sphinx_build(app, status, warning):
-    app.build()
-    html = (app.outdir/'index.html').read_text()
-
-    assert r"\(math\)" in html
-    assert r"\[displaymath\]" in html
-    assert "$nomath$" in html
-
-    assert "$math$" not in html
-    assert "$$displaymath$$" not in html
-
-    assert r"\(nomath\)" not in html
-    assert r"\(displaymath\)" not in html
-
-    assert r"\[math\]" not in html
-    assert r"\[nomath\]" not in html
-
-    assert not status.read()
-    assert not warning.read()
-
-def test_sphinx_build():
-    _test_sphinx_build()

sphinx_math_dollar/tests/test_math_dollar.py

@@ -1,57 +0,0 @@
-from ..math_dollar import split_dollars
-
-def test_split_dollars():
-    assert split_dollars("Text") == [("text", "Text")]
-    assert split_dollars(r"$\sin(x)$") == [("math", r"\sin(x)")]
-    assert split_dollars(r"$\sin(x)") == [("text", r"$\sin(x)")]
-
-    assert split_dollars(r"$\sin(x)$ and $\cos(x)$") == \
-        [
-            ("math", r"\sin(x)"),
-            ("text", " and "),
-            ("math", r"\cos(x)"),
-        ]
-    assert split_dollars(r"The functions $\sin(x)$ and $\cos(x)$.") == \
-        [
-            ("text", "The functions "),
-            ("math", r"\sin(x)"),
-            ("text", " and "),
-            ("math", r"\cos(x)"),
-            ("text", "."),
-        ]
-
-    assert split_dollars(r"$\sin(x)$ and $\cos(x)$") == \
-        [
-            ("math", r"\sin(x)"),
-            ("text", " and "),
-            ("math", r"\cos(x)"),
-        ]
-
-    assert split_dollars("Math that is split across lines $\\sin(x) +\n\\cos(x)$.") == \
-        [
-            ("text", "Math that is split across lines "),
-            ("math", "\\sin(x) +\n\\cos(x)"),
-            ("text", "."),
-        ]
-
-    assert split_dollars('$f(n) = 0 \text{ if $n$ is prime}$ $f(n) = 0 \text{ if $n$ is prime}$ \text{ if $n$ is prime}')
-
-    assert split_dollars(r"$ ls") == [("text", "$ ls")]
-    assert split_dollars("$ cd ..\n$ ls") == [("text", "$ cd ..\n$ ls")]
-
-    assert split_dollars(r"\$13 + \$14") == [("text", "$13 + $14")]
-    assert split_dollars(r"$\$13 + \$14$") == [("math", "$13 + $14")]
-    assert split_dollars(r"$\$13$.") == [("math", "$13"), ("text", ".")]
-    assert split_dollars(r"    $\sin(x)$") == [("text", "    "), ("math", r"\sin(x)")]
-
-    assert split_dollars(r"$$\sin(x)$$") == [("display math", r"\sin(x)")]
-    assert split_dollars(r"$$\sin(x)$") == [("text", r"$$\sin(x)$")]
-    assert split_dollars(r"$$\sin(x)") == [("text", r"$$\sin(x)")]
-    assert split_dollars(r"\$$\sin(x)$$") == [("text", r"$$\sin(x)$$")]
-    assert split_dollars(r"\$\$\sin(x)\$\$") == [("text", r"$$\sin(x)$$")]
-    assert split_dollars(r"$\sin(x)$ and $$\cos(x)$$") == \
-        [
-            ("math", r"\sin(x)"),
-            ("text", " and "),
-            ("display math", r"\cos(x)"),
-        ]

sphinx_math_dollar-1.2.dist-info/RECORD

@@ -1,12 +0,0 @@
-sphinx_math_dollar/__init__.py,sha256=B7vcU5K4KIYSODDwl12G06VSz5HBBBTOaBrKa5t5_Wo,233
-sphinx_math_dollar/_version.py,sha256=VBI4Ekkzeg6O4FL5xZ-ny7WyxElT94e8Qygtqgkp4W0,495
-sphinx_math_dollar/extension.py,sha256=31aT5D3fggQCSraVksg7IAkwAxguNu1ZQ8G9L6lishE,2639
-sphinx_math_dollar/math_dollar.py,sha256=nEThpznw83f1GfCYvOyVaPUMOhA1bZBn_KR8W5cgEGY,2609
-sphinx_math_dollar/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sphinx_math_dollar/tests/test_extension.py,sha256=cpSXgyDQe48giG4qalO5jh63I4t-5NvwW1Y6Aojr9Gg,727
-sphinx_math_dollar/tests/test_math_dollar.py,sha256=FiM8IPYehBMxe2zLee6DNNu441UYa7lW7yAGL5RFoGA,2206
-sphinx_math_dollar-1.2.dist-info/LICENSE,sha256=vzfYNl5zzbBlGs990eAErxdU5hhaq5AjfVy5bkW58_c,1071
-sphinx_math_dollar-1.2.dist-info/METADATA,sha256=DY8s0x7rl145tUuIPFW1gUaIGM4wOh2grbg80rj8JMo,3265
-sphinx_math_dollar-1.2.dist-info/WHEEL,sha256=ewwEueio1C2XeHTvT17n8dZUJgOvyCWCt0WVNLClP9o,92
-sphinx_math_dollar-1.2.dist-info/top_level.txt,sha256=P68HuyABkdfqVE9nYxjqUxClEj1MMo-9KMv5Iwl5wVw,19
-sphinx_math_dollar-1.2.dist-info/RECORD,,