search

boschglobal / doxysphinx

A lightweight Doxygen extension for Sphinx
https://boschglobal.github.io/doxysphinx/
MIT License
7 stars 11 forks source link

Source files with "complex" math in rst are skipped #143

Open Rubyfi opened 1 week ago

Rubyfi commented 1 week ago

Describe the bug When using more complex math (e.g. matrixes), doxysphinx seems to skip the respective hpp/cpp files without an error message.

To Reproduce Steps to reproduce the behavior:

  1. Drop the attached source file in demo/demo/src
  2. Build the documentation
  3. Build will succeed without additional error messages
  4. File is not included in the demo section

Expected behavior The file should be registered and the formulae should be rendered correctly. I've attached an rst file that shows that the formula is correct and can be rendered when directly used in rst.

Desktop (please complete the following information):

Example files math_example.zip

Rubyfi commented 1 week ago

Seems like this issue is caused by doxygen ~but has been fixed with the latest release.~ ~I tried building the example with the fixes supplied with #141 and everything worked fine.~

Rubyfi commented 1 week ago

Update: I've found the culprit of this issue. \dot is a Doxygen command that should usually not be resolved inside verbatims. I've retried again with Doxygen 1.9.8 vs 1.11.0 and it really seems like my initial comment was correct, when using 1.11.0, the issue does not occur anymore.