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

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

Open
Rubyfi opened this issue Jun 28, 2024 · 2 comments
Open

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

Rubyfi opened this issue Jun 28, 2024 · 2 comments

Comments

@Rubyfi
Copy link
Contributor

Rubyfi commented Jun 28, 2024

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):

  • OS: Windows (WSL)

Example files
math_example.zip

@Rubyfi
Copy link
Contributor Author

Rubyfi commented Jun 28, 2024

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

Rubyfi commented Jun 28, 2024

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.

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

1 participant