search

mattnotmitt / doxygen-action

GitHub Action for generating Doxygen documentation for your projects.
MIT License
98 stars 38 forks source link

Question: Does this action support LaTeX styled equations in the doxygen documentation? #3

Closed tomeichlersmith closed 4 years ago

tomeichlersmith commented 4 years ago

I am working on a larger coding project and we are looking for a method that can automatically update our doxygen-generated documentation. Our project is physics-related, so there are several places where having equations is helpful for documenting the code.

I'm not familiar with GitHub actions, so I'm not sure if this docker image you are using has LaTeX installed in it.

mattnotmitt commented 4 years ago

It doesn't have the functionality to build latex PDFs, but it does support rendering LaTeX in the web output with MathJax. You can see an example of the output here and the source for this function's documentation is here. You might have to fiddle with your doxyfile to get it all working, so I'd recommend rendering it locally before starting to build it with this action.

tomeichlersmith commented 4 years ago

That answers my question. Thank you!

mattnotmitt commented 4 years ago

Happy to help!