search

NGEET / fates-docs

Documentation source code for the FATES model
BSD 3-Clause "New" or "Revised" License
10 stars 14 forks source link

switch to math jax? #31

Closed rgknox closed 4 months ago

rgknox commented 2 years ago

I vaguely recall that math jax might provide crisper equations, this option is available in our documentation build system. Perhaps we should change to it.

rgknox commented 1 year ago

I just happened to be looking at this biogeosciences ref by Martinez-Cano et al., and I noticed they had an optional MathJax method of rendering the equations:

https://bg.copernicus.org/articles/16/847/2019/

I thought the mathjax really looked much nicer, it would be nice to give it a try here

wwieder commented 1 year ago

@olyson, maybe we can try something similar with the CLM documentation?

olyson commented 1 year ago

No idea how to do this right now, but maybe we can bring it up at a software meeting.

glemieux commented 12 months ago

We will likely need a requirements.txt file to specify the mathjax package to use, which fates-docs currently does not have. See fates-users-guide for example.

glemieux commented 12 months ago

Note that @adamhb tested out mathjax locally on his setup with success per https://github.com/NGEET/fates-docs/pull/57#discussion_r1329420154. His PR #57 has a commit with the config update including mathjax that is commented out. We should try and enable this in a future PR.

glemieux commented 4 months ago

Closing per #66