Add Doxygen and generate docs to GH Pages#884
Draft
versable wants to merge 6 commits intoTry:masterfrom
Draft
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Hey @Try,
as I mentioned in #594, I present a WIP implementation of Doxygen generated docs.
I have evaluated several tools, but came to the conclusion that Doxygen is the only sane choice, as it is robust, readily available (in the Debian/Ubuntu repository) and a perfect fit for the GH Actions workflow.
To modernize the interface, I have opted to use doxygen-awesome-css (Also readily available in the Debian/Ubuntu repository). This PR shows the code for a basic implementation.
Here is a preview on my forked OpenGothic repository (Only implemented mainwindow.h):
https://versable.github.io/OpenGothic/
https://versable.github.io/OpenGothic/classMainWindow.html
Please mark this as draft.