-
-
Notifications
You must be signed in to change notification settings - Fork 246
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
ci: generate doxygen gh-pages (#3000) #3032
Conversation
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.
I don't think we want this for each PR, and it should be a weekly update for develop, IMHO.
For 1.14.x, the document should only be updated/generated for a release.
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.
I want to recommend it for each PR because developers often forget to document codes properly.
Doxygen is very good at detecting lexical error.
It is also useful for writing documentation first approach in software development (e.g., API prototyping with skeleton).
By the way, please check these URLs if you want to see the latest manuals until this action is merged:
https://hdfeos.github.io/hdf5/develop/
https://hdfeos.github.io/hdf5/1.14.1/
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.
We discussed a separate action to check for doxygen warnings and other issues for PRs. This #3000 is for generating up-to-date docs.
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.
the daily-build process shouild generate docs - there should be a PR check ci for warnings only.
@byrnHDF Where does the daily generated docs go? Are they available on any website? |
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
|
||
|
||
- name: Build 1.14.1 Documentation |
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.
Why build 1.14.1 docs in a develop PR? Also, this file will need to be fixed every time 1.14 is released.
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.
[Get branch name · Actions · GitHub Marketplace]
( https://github.com/marketplace/actions/get-branch-name )
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.
Allen's PRs create doxygen now |
This will generate Doxgen documents under:
https://HDFGroup.github.io/hdf5/develop
https://HDFGroup.github.io/hdf5/1.14.1
To see the updated documents,
the repository owner should give the proper permission and
activate pages following this guide:
https://docs.github.com/en/pages/quickstart
Here are the working demo pages:
https://hyoklee.github.io/actions/develop/
https://hyoklee.github.io/actions/1.14.1/
Close #3000.