This is an archive of the discontinued LLVM Phabricator instance.

Doxygen: Use mathjax
ClosedPublic

Authored by MatzeB on Nov 24 2015, 9:51 AM.

Details

Summary

Does anyone have experiences (or objections) to this settings change?

The main motivation is to not require a latex installation when building the documentation. I would also expect a better image quality and the ability to copy&paste from formulas with a javascript based solution for displaying the math.

Diff Detail

Repository
rL LLVM

Event Timeline

MatzeB updated this revision to Diff 41060.Nov 24 2015, 9:51 AM
MatzeB retitled this revision from to Doxygen: Use mathjax.
MatzeB updated this object.
MatzeB set the repository for this revision to rL LLVM.
MatzeB added a subscriber: llvm-commits.
silvas added a subscriber: silvas.Nov 24 2015, 4:41 PM

I haven't used the option before, but using mathjax seems like a win.
Do you have a particular page of our doxygen that you are looking at where
we use math?

Anyway, give it a shot and we can always roll back if it is undesirable.

Adding Hans just as an FYI, since IIRC he was generating the doxygen for
the release and may want to be aware of what is happening here in case it
causes some issue.

  • Sean Silva
hans added a subscriber: hans.Nov 24 2015, 4:47 PM

I didn't know I needed LaTeX to build the docs before (though I have it installed, so I might not have noticed). I'm also curious to know where we use this in the doxygen.

Anyway, the change seems fine to me.

I haven't used the option before, but using mathjax seems like a win.
Do you have a particular page of our doxygen that you are looking at where
we use math?

Anyway, give it a shot and we can always roll back if it is undesirable.

Adding Hans just as an FYI, since IIRC he was generating the doxygen for
the release and may want to be aware of what is happening here in case it
causes some issue.

  • Sean Silva

At least our jenkins documentation builder is spewing errors about missing latex. I found out after creating this patch that these errors are non-fatal (and the root cause for failing jenkins bot was something else).

Anyway as far as I can see the only place where we have a formula is in llvm/ADT/DAGDeltaAlgorithm.h, I'll give the mathjax variant a go and see how it goes.

This revision was automatically updated to reflect the committed changes.