Online documentation does not render table/TeX for DaphneDSL trig functions #673
Labels
doc
About some form of documentation. Could be doxygen comments in the source, user documentation, etc.
Comments
AlexRTer
changed the title
pdamme
added
the
doc
|
Hi @AlexRTer github has its own md flavor, while we use mkdocs with the material theme to build our html representation, in the best case we find sth that works for both so that it can be rendered for both. It seems that both mkdocs-material and github support mathjax https://squidfunk.github.io/mkdocs-material/reference/math/ KR |
philipportner
pushed a commit
that referenced
this issue
May 28, 2024
* enable mathjax * fix indent in yml, minor doc fixes * minor clarification This PR closes #673. The current online documentation is generated using mkdocs with the material theme. Thus, MathJax can simply be enabled in mkdocs.yml and needs to have the corresponding JavaScript runtimes linked. This PR adds the default setup suggested at https://squidfunk.github.io/mkdocs-material/reference/math/ without further customization (instant loading is not enabled in mkdocs.yml so the corresponding section in mathjax.js has been left out for now). MathJax allows for TeX expressions to be rendered properly in the online documentation using $...$, \(...\) for inline- and $$...$$, \[...\] for block-syntax. Please note that the block syntax requires to have the enclosing $$ on separate lines each (https://squidfunk.github.io/mkdocs-material/reference/math/#using-block-syntax). On Github, most of these expressions are rendered properly. There are some exceptions, e.g. spacing $... \, ...$.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The table and TeX snippets for
Trigonometric/Hyperbolicfunctions at https://github.com/daphne-eu/daphne/blob/main/doc/DaphneDSL/Builtins.md#trigonometrichyperbolic display as expected on github.However, the online documentation https://daphne-eu.github.io/daphne/DaphneDSL/Builtins/ does not render either of them correctly and instead displays mostly unformatted text and symbols.
The text was updated successfully, but these errors were encountered: