Fix Documentation - #270
Merged
merakulix merged 4 commits intoAug 3, 2026
Merged
Conversation
merakulix
reviewed
Jul 22, 2026
merakulix
left a comment
merakulix
left a comment
Contributor
There was a problem hiding this comment.
Everything seems to be there, but when I build the docs locally, scrolling is not possible.
Contributor
Author
Did you see my comment?
|
Contributor
|
Sorry, sure, cosidering these changes it looks good! |
merakulix
deleted the
267-tixi-documentation-missing-docstring-generated-documentation
branch
August 3, 2026 11:01
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #267.
The issue is that newer doxygen versions are more strict when parsing the beginning and end marks for doxygen groups. Previously, the documentation was most likely built with doxygen 1.8.x and now we are using 1.13.2.
The
/*@{*/had to be replaced with/**@{*/.In addition to this, I fixed a wrong argument documentation and updated the doxyfile using
doxygen -uto get rid of some warnings. And I updated the pixi lock file.Note that the large changes in Doxyfile.in and pixi.lock are auto-generated by doxygen and pixi respectively.
In doxygen 1.13.2 there is still an issue that breaks page scrolling, doxygen/doxygen#11379. I manually fixed it by modifying resize.js in the gh-pages branch. The issue is resolved in doxygen 1.14.0, which is not yet on conda-forge.