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

Math formulas are not correctly displayed in Doxygen documentation #2

Open
traversaro opened this issue Dec 17, 2020 · 4 comments
Open

Comments

@traversaro
Copy link
Member

Describe the bug
Math documentation in http://www.yarp.it/git-master/classyarp_1_1dev_1_1IOrientationSensors.html#adb2a40d03c747aa9c8b7fc542f193fd9 is not correctly render, probably due to some missing option passed to doxygen during the generation process.

To Reproduce
Visit http://www.yarp.it/git-master/classyarp_1_1dev_1_1IOrientationSensors.html#adb2a40d03c747aa9c8b7fc542f193fd9 and see raw latex formulas .

Expected behavior
The math formula rendered, see http://mathb.in/48272 .

Configuration (please complete the following information):

  • OS: Windows
  • yarp version: Not Relevant
  • compiler: Not Relevant
@traversaro
Copy link
Member Author

cc @Nicogene

@PeterBowman
Copy link
Member

PeterBowman commented Dec 17, 2020

One way to handle this is through Doxygen's CITE_BIB_FILES property: inline comment, HTML+LaTeX render. I'd suggest to take advantage of the modern FindDoxygen module which takes care of generating a Doxyfile from CMake configuration and creating a new target that calls doxygen to parse it: example. That is, no more Doxyfile.in.

Edit: ouch, sorry, CITE_BIB_FILES is obviously meant for citations... Anyway, I wanted to point out that this configuration produces correct LaTeX output in one way or another, I just had to increase the font size to make formulae more readable.

@traversaro
Copy link
Member Author

Thanks for chiming in @PeterBowman !

@drdanz
Copy link
Member

drdanz commented Dec 21, 2020

I believe this could be due to some missing latex package in the documentation build environment, I'll move this to the robotology/yarp-documentation repository...

@drdanz drdanz transferred this issue from robotology/yarp Dec 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants