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

switch to math jax? #31

Closed
rgknox opened this issue Aug 29, 2022 · 6 comments · Fixed by #66
Closed

switch to math jax? #31

rgknox opened this issue Aug 29, 2022 · 6 comments · Fixed by #66
Assignees
Labels
enhancement New feature or request infrastructure improvements or issues pertaining to the documentation infrastructure code

Comments

@rgknox
Copy link
Collaborator

rgknox commented Aug 29, 2022

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.

@glemieux glemieux self-assigned this Sep 19, 2022
@glemieux glemieux moved this to 🟢 In Progress in FATES issue board Sep 19, 2022
@glemieux glemieux added enhancement New feature or request infrastructure improvements or issues pertaining to the documentation infrastructure code labels Aug 10, 2023
@rgknox
Copy link
Collaborator Author

rgknox commented Aug 31, 2023

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
Copy link

wwieder commented Aug 31, 2023

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

@olyson
Copy link

olyson commented Aug 31, 2023

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

@glemieux
Copy link
Contributor

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
Copy link
Contributor

Note that @adamhb tested out mathjax locally on his setup with success per #57 (comment). 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 glemieux linked a pull request May 2, 2024 that will close this issue
@glemieux
Copy link
Contributor

glemieux commented May 2, 2024

Closing per #66

@glemieux glemieux closed this as completed May 2, 2024
@github-project-automation github-project-automation bot moved this from 🟢 In Progress to ✔ Done in FATES issue board May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request infrastructure improvements or issues pertaining to the documentation infrastructure code
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants