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

Docs: Doxygen Documentation Deployment #4264

Merged
merged 22 commits into from
May 31, 2024
Merged

Conversation

jinzx10
Copy link
Collaborator

@jinzx10 jinzx10 commented May 29, 2024

Reminder

  • Have you linked an issue with this pull request?
  • Have you added adequate unit tests and/or case tests for your pull request?
  • Have you noticed possible changes of behavior below or in the linked issue?
  • Have you explained the changes of codes in core modules of ESolver, HSolver, ElecState, Hamilt, Operator or Psi? (ignore if not applicable)

What's changed?

A new workflow that deploys the doxygen-generated html documentation as github pages is added. The workflow will be triggered whenever there is a push event (like the merge of a PR) to the "develop" branch.

Update:
The workflow is configured such that only one deployment can exist at any time, i.e., if multiple PRs are merged within a short period of time, only the one triggered by the last merge will be executed; those triggered by previous PRS will be cancelled.

A preview of the documentation can be found at https://jinzx10.github.io/abacus-develop/

doxygen/Doxyfile Outdated Show resolved Hide resolved
Copy link
Collaborator

@mohanchen mohanchen left a comment

Choose a reason for hiding this comment

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

Nice feature.

@jinzx10
Copy link
Collaborator Author

jinzx10 commented May 30, 2024

The workflow is configured such that only one can exist at any time. If multiple PRs are merged within a short period of time, while each of them will trigger the deployment action, only the one triggered by the last merge will be fully executed; those by the previous PRs will be automatically cancelled, even in progress.

@mohanchen mohanchen merged commit 2061df9 into deepmodeling:develop May 31, 2024
13 checks passed
@jinzx10 jinzx10 deleted the doxygen branch May 31, 2024 09:41
@mohanchen mohanchen added the Compile & CICD & Docs Issues related to compiling ABACUS label Jun 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Compile & CICD & Docs Issues related to compiling ABACUS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants