Sphinx extension to let you write LaTeX math using $$
Project description
sphinxmathdollar is a Sphinx extension to let you write LaTeX math using $$.
To enable install it
pip install sphinxmathdollar
or
conda install c condaforge sphinxmathdollar
Then in your conf.py, add 'sphinx_math_dollar' to your extensions list:
extensions = ['sphinx_math_dollar', 'sphinx.ext.mathjax']
mathjax_config = {
'tex2jax': {
'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 $intsin(x),dx$. You can also use double dollar signs for display math, like $$\int\sin(x)\,dx$$, which produces $$intsin(x),dx$$ (if you are reading this on GitHub, look at the version built by Sphinx here). 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 extension.
Configuration
sphinxmathdollar uses a blacklist to determine which docutils nodes should not be parsed. The default blacklist is
(FixedTextElement, literal, math)
FixedTextElement covers the Simple Body Elements 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, add
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.
License
MIT.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinx_math_dollar1.2.1py3noneany.whl
Algorithm  Hash digest  

SHA256  0b1523a4d7023b9020ddf3a9301f651d64427a0f1d802af534a87eaf24fbdf19 

MD5  5b149b265e4ca3c36bd4edfe0ea2eec4 

BLAKE2256  9658f4df1f1cd8a2bd7c5720870fcd1373fbd6de934f74c887bbc40eef9d8328 