Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable MathJax for documentation #726

Merged
merged 3 commits into from
May 28, 2024

Conversation

AlexRTer
Copy link
Collaborator

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 $... \, ...$.

There are also a few minor changes to improve consistency and fix some formatting errors in the docs.
I attempted to clarify the documentation for ctables, please change this back if you deem it unnecessary.

@philipportner philipportner self-requested a review May 21, 2024 07:17
@philipportner
Copy link
Collaborator

LGTM and the output is now nicely displayed. Thanks for the fix @AlexRTer !

@philipportner philipportner merged commit 1f7ba88 into daphne-eu:main May 28, 2024
2 checks passed
@AlexRTer AlexRTer deleted the docs-enable-mathjax branch June 25, 2024 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Online documentation does not render table/TeX for DaphneDSL trig functions
2 participants