Inline math delimited with $ ... $ should work in html output out of the box with --config latex_math=True specified.
It is supported in pandoc (link), GitHub (link), and finally it is being rolled out in GitLab (link) (this behavior still under-documented in official docs though). I create this issue based on @kernc reply in https://github.com/pdoc3/pdoc/issues/28#issuecomment-1281176366.
This unification is important, because users will be saved from the frustration when they are trying to display their math on multiple places, such as GitHub readme, GitLab readme, pdoc3 HTML, pdoc3 + pandoc PDF output, ...
Actual Behavior
Currently, the dollar delimiter style works only for blocks of math with $$...$$.
Steps to Reproduce
Steps for Ubuntu
mkdir tmp
virtualenv .venv
pip install pdoc3
source .venv/bin/activate
nano test.py, paste the code from bellow and save the file
run pdoc test.py --html --force --config latex_math=True
go to html folder and open test.html in your browser
if you wish, you can also generate and check the pdf output with: pdoc test.py --pdf | pandoc --metadata=title:"test" --from=markdown+abbreviations+tex_math_dollars --pdf-engine=xelatex --output=tmp.pdf
"""
This style of inline math delimited with 'brackets' works and should continue working \(\mathcal{O}(N)\).
This style of inline math delimited with 'dollars' should work $\mathcal{O}(N)$.
Escaping \$ should work in math like $X = \$3.25$ once it is implemented.
Blocks of math are already supported with the \$ delimiter and should stay so:
$$
\mathcal{O}(N) \\
X = \$3.25
$$
Blocks of math delimited with 'brackets' style are supported and should stay so:
\[
\mathcal{O}(N) \\
X = \$3.25
\]
Numbered blocks seem not to be supported and would be great if they would be.
The equation number now just jumpt to a new line like standard text:
$$
\mathcal{O}(N) \\
X = \$3.25
$$ (1)
\[
\mathcal{O}(N) \\
X = \$3.25
\] (1)
Line break in math blocks with two backslashes does not work. It seems MathJax includes this in v4.0.0-alpha.1.
https://github.com/mathjax/MathJax/issues/2312#issuecomment-1264672050
"""
You should get this HTML output:
You should get this PDF output:
Additional info
pdoc version: 0.10.0 and bellow
For those who want a workaround: Copy the head.mako from .venv/lib/python3.8/site-packages/pdoc/templates to your desired location, fill it with code from this answer, and then compile your documentation with custom --template-dir as @kernc suggested https://github.com/pdoc3/pdoc/issues/28#issuecomment-463169239.
Expected Behavior
Inline math delimited with
$ ... $should work in html output out of the box with--config latex_math=Truespecified. It is supported in pandoc (link), GitHub (link), and finally it is being rolled out in GitLab (link) (this behavior still under-documented in official docs though). I create this issue based on @kernc reply in https://github.com/pdoc3/pdoc/issues/28#issuecomment-1281176366.This unification is important, because users will be saved from the frustration when they are trying to display their math on multiple places, such as GitHub readme, GitLab readme, pdoc3 HTML, pdoc3 + pandoc PDF output, ...
Actual Behavior
Currently, the dollar delimiter style works only for blocks of math with
$$...$$.Steps to Reproduce
Steps for Ubuntu
mkdir tmpvirtualenv .venvpip install pdoc3source .venv/bin/activatenano test.py, paste the code from bellow and save the filepdoc test.py --html --force --config latex_math=Truehtmlfolder and opentest.htmlin your browserpdoc test.py --pdf | pandoc --metadata=title:"test" --from=markdown+abbreviations+tex_math_dollars --pdf-engine=xelatex --output=tmp.pdfYou should get this HTML output:
You should get this PDF output:
Additional info
For those who want a workaround: Copy the
head.makofrom.venv/lib/python3.8/site-packages/pdoc/templatesto your desired location, fill it with code from this answer, and then compile your documentation with custom--template-diras @kernc suggested https://github.com/pdoc3/pdoc/issues/28#issuecomment-463169239.