Skip to content
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

Closed
wants to merge 1 commit into from

Conversation

hyoklee
Copy link
Member

@hyoklee hyoklee commented Jun 1, 2023

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.

Copy link
Contributor

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.

Copy link

@hdfeos hdfeos Jun 1, 2023

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/

Copy link
Contributor

@brtnfld brtnfld Jun 1, 2023

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.

@hyoklee hyoklee added Priority - 3. Low 🔽 Code cleanup, small feature change requests, etc. and removed Priority - 0. Blocker ⛔ This MUST be merged for the release to happen labels Jun 2, 2023
Copy link
Contributor

@byrnHDF byrnHDF left a 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.

@hyoklee
Copy link
Member Author

hyoklee commented Jun 2, 2023

@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
Copy link
Contributor

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.

Copy link
Contributor

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 )

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@byrnHDF Thanks for reviewing! This PR was a quick demo patch for @brtnfld to show him how both develop & 1.14.1-2 Doxygen documentation should look like on GH pages since S3 docs were out of sync.

@derobins
Copy link
Member

derobins commented Jun 6, 2023

Allen's PRs create doxygen now

@derobins derobins closed this Jun 6, 2023
@hyoklee
Copy link
Member Author

hyoklee commented Jun 6, 2023

@derobins Does @byrnHDF PRs generate gh-pages? Where are they?

@hyoklee hyoklee reopened this Jun 6, 2023
@byrnHDF
Copy link
Contributor

byrnHDF commented Jun 6, 2023

@derobins Does @byrnHDF PRs generate gh-pages? Where are they?

First things first! It is in process.

@byrnHDF byrnHDF closed this Jun 6, 2023
@hyoklee hyoklee deleted the hyoklee-issue-3000 branch June 7, 2023 15:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Build CMake, Autotools Component - Documentation Doxygen, markdown, etc. Priority - 3. Low 🔽 Code cleanup, small feature change requests, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update documentation (website) for 1.14.1 and 1.15.0
6 participants