sphinx-math-dollar 1.2__tar.gz → 1.3__tar.gz

sphinx_math_dollar-1.3/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.4
+Name: sphinx-math-dollar
+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
+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 in RST using $$.
+
+To enable install it
+
+.. code::
+
+   pip install sphinx-math-dollar
+
+or
+
+.. code::
+
+   conda install -c conda-forge sphinx-math-dollar
+
+Then in your ``conf.py``, add ``'sphinx_math_dollar'`` to your extensions list:
+
+.. code:: python
+
+   extensions = ['sphinx_math_dollar', 'sphinx.ext.mathjax']
+
+   mathjax_config = {
+       'tex2jax': {
+           'inlineMath': [ ["\\(","\\)"] ],
+           'displayMath': [["\\[","\\]"] ],
+       },
+   }
+
+   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.
+
+You will now be able to use dollar signs for math, like ``$\int\sin(x)\,dx$``,
+which will produce $\int\sin(x)\,dx$. You can also use double dollar signs for
+display math, like ``$$\int\sin(x)\,dx$$``, which produces $$\int\sin(x)\,dx$$
+(if you are reading this on GitHub, look at the version built by Sphinx `here
+<https://www.sympy.org/sphinx-math-dollar/>`_). The usual Sphinx ``:math:``
+and ``.. math::`` directives will also continue to work.
+
+The extension will also work with docstrings when combined with the
+`sphinx.ext.autodoc
+<https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html>`_
+extension.
+
+Configuration
+=============
+
+sphinx-math-dollar uses a blacklist to determine which `docutils nodes
+<http://docutils.sourceforge.net/docs/ref/doctree.html>`_ should not be
+parsed. The default blacklist is
+
+.. code::
+
+   (FixedTextElement, literal, math)
+
+``FixedTextElement`` covers the `Simple Body Elements
+<http://docutils.sourceforge.net/docs/ref/doctree.html>`_ nodes.
+
+Any docutils node that is contained in a blacklisted node or a subclass of a
+blacklisted node will not have ``$math$`` parsed as LaTeX.
+
+You can modify this by setting ``math_dollar_node_blacklist`` in ``conf.py``.
+For example, to also prevent ``$math$`` from rendering in `headers nodes
+<http://docutils.sourceforge.net/docs/ref/doctree.html#header>`_, add
+
+.. code:: python
+
+   from sphinx_math_dollar import NODE_BLACKLIST
+   from docutils.nodes import header
+
+   math_dollar_node_blacklist = NODE_BLACKLIST + (header,)
+
+Note that configuring this variable replaces the default, so it is recommended
+to always include the above default values (``NODE_BLACKLIST``) in addition to
+additional nodes.
+
+To debug which nodes are skipped, set the environment variable
+``MATH_DOLLAR_DEBUG=1`` or set ``math_dollar_debug = True`` in ``conf.py``.
+
+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.2 → sphinx_math_dollar-1.3}/README.rst

@@ -2,7 +2,7 @@
  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
 
@@ -29,6 +29,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.
@@ -83,6 +90,33 @@ 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
 =======
 

sphinx_math_dollar-1.3/docs/conf.py

@@ -0,0 +1,67 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'sphinx-math-dollar'
+copyright = '2019, SymPy Development Team'
+author = 'SymPy Development Team'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx_math_dollar',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.githubpages',
+]
+
+html_theme_options = {
+    'github_user': 'sympy',
+    'github_repo': 'sphinx-math-dollar',
+    'github_banner': True,
+    'logo_name': True,
+    'travis_button': True,
+    'show_related': True,
+}
+
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ['_static']
+
+master_doc = 'index'

sphinx_math_dollar-1.3/pyproject.toml

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

{sphinx-math-dollar-1.2 → sphinx_math_dollar-1.3}/setup.cfg

@@ -1,5 +1,5 @@
 [versioneer]
-vcs = git
+VCS = git
 style = pep440
 versionfile_source = sphinx_math_dollar/_version.py
 versionfile_build = sphinx_math_dollar/_version.py

{sphinx-math-dollar-1.2 → sphinx_math_dollar-1.3}/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,16 +18,17 @@ setuptools.setup(
     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(),
+    packages=setuptools.find_packages(include=["sphinx_math_dollar"]),
     classifiers=[
-        "Programming Language :: Python :: 2",
         "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
+        "Programming Language :: Python :: 3.14",
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
     ],
-    # python_requires= '>=3.6',
-    install_requires=[
-        'sphinx'
-    ],
-    license='MIT',
+    python_requires=">=3.11",
+    install_requires=["sphinx"],
+    license="MIT",
 )

{sphinx-math-dollar-1.2 → sphinx_math_dollar-1.3}/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-1.2 → sphinx_math_dollar-1.3}/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-1.2 → sphinx_math_dollar-1.3}/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 → sphinx_math_dollar-1.3}/sphinx_math_dollar/tests/test_extension.py

@@ -1,10 +1,12 @@
-import os
+import pytest
 
-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):
+def test(app):
+    app.build()
+
+
+@pytest.mark.sphinx(buildername='html')
+def test_sphinx_build(app, status, warning):
     app.build()
     html = (app.outdir/'index.html').read_text()
 
@@ -23,6 +25,3 @@ def _test_sphinx_build(app, status, warning):
 
     assert not status.read()
     assert not warning.read()
-
-def test_sphinx_build():
-    _test_sphinx_build()

sphinx_math_dollar-1.3/sphinx_math_dollar.egg-info/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.4
+Name: sphinx-math-dollar
+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
+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 in RST using $$.
+
+To enable install it
+
+.. code::
+
+   pip install sphinx-math-dollar
+
+or
+
+.. code::
+
+   conda install -c conda-forge sphinx-math-dollar
+
+Then in your ``conf.py``, add ``'sphinx_math_dollar'`` to your extensions list:
+
+.. code:: python
+
+   extensions = ['sphinx_math_dollar', 'sphinx.ext.mathjax']
+
+   mathjax_config = {
+       'tex2jax': {
+           'inlineMath': [ ["\\(","\\)"] ],
+           'displayMath': [["\\[","\\]"] ],
+       },
+   }
+
+   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.
+
+You will now be able to use dollar signs for math, like ``$\int\sin(x)\,dx$``,
+which will produce $\int\sin(x)\,dx$. You can also use double dollar signs for
+display math, like ``$$\int\sin(x)\,dx$$``, which produces $$\int\sin(x)\,dx$$
+(if you are reading this on GitHub, look at the version built by Sphinx `here
+<https://www.sympy.org/sphinx-math-dollar/>`_). The usual Sphinx ``:math:``
+and ``.. math::`` directives will also continue to work.
+
+The extension will also work with docstrings when combined with the
+`sphinx.ext.autodoc
+<https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html>`_
+extension.
+
+Configuration
+=============
+
+sphinx-math-dollar uses a blacklist to determine which `docutils nodes
+<http://docutils.sourceforge.net/docs/ref/doctree.html>`_ should not be
+parsed. The default blacklist is
+
+.. code::
+
+   (FixedTextElement, literal, math)
+
+``FixedTextElement`` covers the `Simple Body Elements
+<http://docutils.sourceforge.net/docs/ref/doctree.html>`_ nodes.
+
+Any docutils node that is contained in a blacklisted node or a subclass of a
+blacklisted node will not have ``$math$`` parsed as LaTeX.
+
+You can modify this by setting ``math_dollar_node_blacklist`` in ``conf.py``.
+For example, to also prevent ``$math$`` from rendering in `headers nodes
+<http://docutils.sourceforge.net/docs/ref/doctree.html#header>`_, add
+
+.. code:: python
+
+   from sphinx_math_dollar import NODE_BLACKLIST
+   from docutils.nodes import header
+
+   math_dollar_node_blacklist = NODE_BLACKLIST + (header,)
+
+Note that configuring this variable replaces the default, so it is recommended
+to always include the above default values (``NODE_BLACKLIST``) in addition to
+additional nodes.
+
+To debug which nodes are skipped, set the environment variable
+``MATH_DOLLAR_DEBUG=1`` or set ``math_dollar_debug = True`` in ``conf.py``.
+
+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.2 → sphinx_math_dollar-1.3}/sphinx_math_dollar.egg-info/SOURCES.txt

@@ -1,9 +1,12 @@
 LICENSE
 MANIFEST.in
 README.rst
+pyproject.toml
 setup.cfg
 setup.py
 versioneer.py
+docs/__init__.py
+docs/conf.py
 sphinx_math_dollar/__init__.py
 sphinx_math_dollar/_version.py
 sphinx_math_dollar/extension.py