Closed sjpfenninger closed 9 months ago
All modified and coverable lines are covered by tests :white_check_mark:
Comparison is base (
e6b7263
) 94.98% compared to head (7247860
) 95.00%.
For math to be rendered, do you just need to add the relevant config and javascript?
Not enough if you want the fenced blocks to work (``math ...). The easiest solution might just be to replace those with the
$$...$$` block syntax.
From https://facelessuser.github.io/pymdown-extensions/extensions/arithmatex/#alternative-math-blocks I gather something like this ought to work but it doesn't so far:
- pymdownx.arithmatex:
generic: true
- pymdownx.superfences:
custom_fences:
- name: math
class: arithmatex
format: !!python/name:pymdownx.arithmatex.arithmatex_fenced_format
First skeleton of mkdocs
Open issues:
custom_math.py
could also run throughgen-files
but because it is quite slow, I think it's better to run it in a seprate pre_build step. Already including those generated markdown files let's build time increase from ~1 second to around 10 seconds, so there is some issue with them anyway. The idea for now would be to runpython ./pre_build/generate_math.py
and any other pre-build steps manually (and in the case of readthedocs, add this as pre-build steps in the readthedocs configuration).extra: version: 0.7.0
in the configuration should come from the installed calliope module, not be hardcoded in the config fileThe idea would be to sort out any issues with the basic setup here, merge this basic setup, then revise and move over the remaining documentation step-by-step, thus also moving from the old
doc
to the newdocs
directory.Reviewer checklist: