Open
Description
Description of the modifications
Operators now accept Markdown/LaTeX in their descriptions to be rendered in the current operator documentation.
The issue is that:
- only a subset of Markdown (CommonMark) is supported by default by the Markdown-to-html tool (md4c)
- only a subset of LaTeX is supported by the LaTeX to svg rendering tool (MathJax)
- only a subset of Markdown is supported by the Markdown-to-RST tool to generate the docstrings of Python operators classes (
These can all be configured and customized, so all current restrictions need to be listed and made explicit in clear guidelines for supported features in a page describing how to create operators.
Useful links and references
md4c
https://github.com/mity/md4c
https://spec.commonmark.org/
MathJax
https://docs.mathjax.org/en/latest/input/tex/delimiters.html
https://docs.mathjax.org/en/latest/input/tex/macros/index.html#environments
pypandoc
https://github.com/JessicaTegner/pypandoc
https://pandoc.org/MANUAL.html#pandocs-markdown
https://pandoc.org/MANUAL.html#math