-
Notifications
You must be signed in to change notification settings - Fork 448
Automate doxygen builds #521
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
Conversation
I've made a job on master branch, to test CI in this PR.
As for other changes/requests - I'll get to it tiny bit later. Too much preoccupied at the moment.
I realize that there is already a branch named github_pages, but I think that branch was meant for a different purpose. The branch published to github pages typically only has the site's HTML resources (not any programming or documentation sources) -- especially when using Doxygen as the static site generator.
The branch used to publish the docs' site can be configured (see here) Default is a branch named gh-pages.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it always blows my mind how many changes this file gets when it gets updated by doxygen
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TBH, I prefer only having settings in the Doxyfile that don't use the default value. Although, I didn't go through that laborious change here.
already a branch named
github_pages, but I think that branch was meant for a different purpose
originally it was created for the same purpose as a playground
we just didn't make it right to the end
at this moment I believe it is time to get rid of it
Co-authored-by: Ihor Dutchak <ihor.youw@gmail.com>
update links in new md file use C-style comments
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the important part that allows eliding specific members from the generated docs. ✏️ Here, I used it to exclude the "helper macros" that don't have a docstring.
Uh oh!
There was an error while loading. Please reload this page.
resolves #5
doxygen -udoxygen/main_page.mdfile as the generated site's main page.gh-pagesbranch for deployment (only for push events to the master branch).Admin prep
The required preparation needed from admins is
gh-pagesbranch root folder as source of deployments.image
I realize that there is already a branch named
github_pages, but I think that branch was meant for a different purpose. The branch published to github pages typically only has the site's HTML resources (not any programming or documentation sources) -- especially when using Doxygen as the static site generator.image
Alternatively (or additionally), a link could be added to the README in the "What does the API look like?" section.