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

Doxygen document generation #337

Merged
merged 24 commits into from
Mar 7, 2024
Merged

Doxygen document generation #337

merged 24 commits into from
Mar 7, 2024

Conversation

Ashu7950
Copy link
Collaborator

@Ashu7950 Ashu7950 commented Mar 4, 2024

IMPORTANT: All PRs must be linked to an issue (except for extremely trivial and straightforward changes).

Fixes #[Issue]

Description

Precise description of the changes in this pull request

Alternative(s) considered

Have you considered any alternatives? And if so, why have you chosen the approach in this PR?

Type

Type Choose one: (Bug fix | Feature | Documentation | Testing | Other)

Screenshots (if applicable)

Checklist

  • I have read the Contribution Guidelines
  • I have written Unit Tests
  • I have discussed my proposed solution with code owners in the linked issue(s) and we have agreed upon the general approach

Copy link

github-actions bot commented Mar 4, 2024

Test Results Linux

  1 files  ±0    1 suites  ±0   10m 25s ⏱️ ±0s
307 tests ±0  234 ✅ ±0  73 💤 ±0  0 ❌ ±0 
234 runs  ±0  161 ✅ ±0  73 💤 ±0  0 ❌ ±0 

Results for commit bf1df81. ± Comparison against base commit 5358310.

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented Mar 4, 2024

Test Results Win-nocuda

  1 files  ±0    1 suites  ±0   10m 34s ⏱️ -1s
303 tests ±0  234 ✅ ±0  69 💤 ±0  0 ❌ ±0 
234 runs  ±0  165 ✅ ±0  69 💤 ±0  0 ❌ ±0 

Results for commit bf1df81. ± Comparison against base commit 5358310.

♻️ This comment has been updated with latest results.

Copy link
Collaborator

@yashrajsapra yashrajsapra left a comment

Choose a reason for hiding this comment

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

@joiskash @mraduldubey

Should we build documentation along with ApraPipes, or should it be separate? Like separate script for building document

Copy link

github-actions bot commented Mar 4, 2024

Test Results Linux-CudaT

  1 files  ±0    1 suites  ±0   10m 30s ⏱️ -1s
408 tests ±0  241 ✅ ±0  167 💤 ±0  0 ❌ ±0 
241 runs  ±0   74 ✅ ±0  167 💤 ±0  0 ❌ ±0 

Results for commit bf1df81. ± Comparison against base commit 5358310.

♻️ This comment has been updated with latest results.

@mraduldubey
Copy link
Collaborator

@joiskash @mraduldubey

Should we build documentation along with ApraPipes, or should it be separate? Like separate script for building document

Both.

  • Launch the doc generation script from the build script
  • Add instructions on readme on how to build only docs separately

Copy link
Collaborator

@mraduldubey mraduldubey left a comment

Choose a reason for hiding this comment

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

Is it possible to show the latest commit hash in the footer of the html pages/doxy output ?

Copy link

github-actions bot commented Mar 4, 2024

Test Results Linux_ARM64

  1 files  ±0    1 suites  ±0   10m 53s ⏱️ ±0s
430 tests ±0  266 ✅ ±0  164 💤 ±0  0 ❌ ±0 
266 runs  ±0  102 ✅ ±0  164 💤 ±0  0 ❌ ±0 

Results for commit bf1df81. ± Comparison against base commit 5358310.

♻️ This comment has been updated with latest results.

joiskash
joiskash previously approved these changes Mar 5, 2024
@yashrajsapra
Copy link
Collaborator

Is it possible to show the latest commit hash in the footer of the html pages/doxy output ?

Part of Commit 1a61333

@yashrajsapra yashrajsapra reopened this Mar 6, 2024
Copy link

github-actions bot commented Mar 7, 2024

Test Results Windows-cuda

  1 files  ±0    1 suites  ±0   12m 34s ⏱️ ±0s
404 tests ±0  297 ✅ ±0  107 💤 ±0  0 ❌ ±0 
297 runs  ±0  190 ✅ ±0  107 💤 ±0  0 ❌ ±0 

Results for commit bf1df81. ± Comparison against base commit 5358310.

@mraduldubey mraduldubey merged commit 491c75e into main Mar 7, 2024
26 of 33 checks passed
@mraduldubey mraduldubey deleted the dOxy branch March 7, 2024 08:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants