-
Notifications
You must be signed in to change notification settings - Fork 19
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
Fixes #668 - Generate and publish Doxygen #673
base: main
Are you sure you want to change the base?
Conversation
5b3f946
to
6745f35
Compare
6745f35
to
86086c1
Compare
Codecov Report
@@ Coverage Diff @@
## main #673 +/- ##
==========================================
- Coverage 25.91% 25.90% -0.01%
==========================================
Files 128 128
Lines 31195 31195
Branches 4973 4973
==========================================
- Hits 8083 8081 -2
Misses 22059 22059
- Partials 1053 1055 +2
Flags with carried forward coverage won't be shown. Click here to find out more.
Help us with your feedback. Take ten seconds to tell us how you rate us. |
An example of a fairly complete doxygen page is https://jiridanek.github.io/skupper-router/group__iterator.html
|
In order to make this actually useful
The usefulness should come from
Overall, the GitHub markdown rendering capabilities (what it does on the fly) are quite sufficient for purposes of the /docs/ folder and nobody as of yet missed doxygen much |
This will create a link in the right-hand panel of the GitHub project page, like the one I now have at my fork https://github.com/jiridanek/skupper-router
When you click the environment link, you get a list of environments, and you can open the latest version of the Doxygen documentation from there
The Doxygen is hosted at https://jiridanek.github.io/skupper-router (it will be at skupperproject.github.io for this repository, after PR is merged)
The site is updated when CI runs for the main branch. When running PR branches, the pages are not deployed.