Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 inmathjax.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.