Merge pull request #38 from MarelliF/master

Update build files and fix incompatibility with other extensions

Author: asmeurer

pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=42.0.0"]
+build-backend = "setuptools.build_meta"

setup.py

@@ -1,3 +1,7 @@
+import pathlib
+import sys
+
+sys.path.append(str(pathlib.Path(__file__).parent))
 import setuptools
 
 with open("README.rst", "r") as fh:
@@ -14,15 +18,13 @@
     description="Sphinx extension to let you write LaTeX math using $$",
     long_description=long_description,
     url="https://github.com/sympy/sphinx-math-dollar/",
-    packages=setuptools.find_packages(include=['sphinx_math_dollar']),
+    packages=setuptools.find_packages(include=["sphinx_math_dollar"]),
     classifiers=[
         "Programming Language :: Python :: 3",
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
     ],
-    python_requires= '>=3.6',
-    install_requires=[
-        'sphinx'
-    ],
-    license='MIT',
+    python_requires=">=3.6",
+    install_requires=["sphinx"],
+    license="MIT",
 )

sphinx_math_dollar/extension.py

@@ -1,30 +1,52 @@
+import logging
 import os
 import sys
 
-from .math_dollar import split_dollars
-from . import __version__
-
-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(str(node).replace('\x00', '\\'))):
-                    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
         # See https://github.com/sympy/sphinx-math-dollar/issues/22
-        data = split_dollars(str(node).replace('\x00', '\\'))
+        data = split_dollars(str(node).replace("\x00", "\\"))
         nodes = []
         has_math = False
         for typ, text in data:
@@ -36,41 +58,45 @@ def visit_Text(self, node):
             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
     # to get the version of the text with backslashes. I'm not sure which all
     # 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('parallel_read_safe', True, '')
+    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,
-    }
+        "version": __version__,
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+    }