daphne-eu / daphne

DAPHNE: An Open and Extensible System Infrastructure for Integrated Data Analysis Pipelines
Apache License 2.0
67 stars 62 forks source link

Online documentation does not render table/TeX for DaphneDSL trig functions #673

Closed AlexRTer closed 5 months ago

AlexRTer commented 8 months ago

The table and TeX snippets for Trigonometric/Hyperbolic functions 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.

pdamme commented 8 months ago

Thanks for flagging this issue @AlexRTer. It seems like MkDocs, the tool we use for generating HTML documentation from our Markdown files, does not support LaTeX out of the box. Maybe @m-birke knows more.

m-birke commented 7 months ago

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/ https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions

KR