Doc: switch Doxygen theme #373
Merged
Conversation
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
athre0z
added
C-enhancement
flobernd
approved these changes
Aug 1, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR replaces the previous m.css theme with doxygen-awesome-css.
While m.css looks great, it has a bunch of problems when used with C. Namely, it generates all symbols and function names in C++ style and doesn't support nested structures well at all. It also had a tendency of somehow omitting documentation for some types. A lot of these issues are down to m.css having a custom HTML generator and thus having to explicitly support each of these features.
The theme that this PR switches to, doxygen-awesome-css, takes the much simpler route of re-styling the existing HTML with CSS and should thus be a lot less prone to errors.
Live demo: https://zydis.re/doc/4/modules