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.

Sign up for GitHub

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

Jump to bottom

Fix docs build #1569

Merged
merged 3 commits into from
Oct 24, 2022
Merged

Fix docs build #1569

merged 3 commits into from
Oct 24, 2022

Conversation

e10harvey
Copy link
Contributor

This PR corrects the source paths for the documentation build. Thanks to @ndellingwood for pointing this out!
The PR also fixes a few regressions (50d812c) noted in doxygen warnings. Note that there are several more doxygen warnings that are currently being ignored.

To guard against regressions going forward, I suggest that we change: WARN_AS_ERROR = YES in Doxyfile.in and add a github actions documentation build. For example:

$ git diff
diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in
index 5cb072a46..c3a662197 100644
--- a/docs/Doxyfile.in
+++ b/docs/Doxyfile.in
@@ -843,7 +843,7 @@ WARN_NO_PARAMDOC       = NO
 # Possible values are: NO, YES and FAIL_ON_WARNINGS.
 # The default value is: NO.
 
-WARN_AS_ERROR          = NO
+WARN_AS_ERROR          = YES
 
 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
 # can produce. The string should contain the $file, $line, and $text tags, which
@@ -871,7 +871,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = @CMAKE_SOURCE_DIR@/sparse/src/ \
+INPUT                  = @CMAKE_SOURCE_DIR@/dne/src/ \
                          @CMAKE_SOURCE_DIR@/blas/src/ \
                          @CMAKE_SOURCE_DIR@/batched/dense/src/ \
                          @CMAKE_SOURCE_DIR@/batched/sparse/src/

$ make Doxygen
Generating docs
warning: Tag 'CLASS_DIAGRAMS' at line 2320 of file 'Doxyfile' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: tag INPUT: input source '/path/to/kokkos-kernels/dne/src/' does not exist
Doxygen version used: 1.9.4
Searching for include files...
Searching for example files...
Searching for images...
Searching for dot files...
Searching for msc files...
Searching for dia files...
Searching for files to exclude
Searching INPUT for files to process...
error: source '/path/to/kokkos-kernels/dne/src' is not a readable file or directory... skipping.
 (warning treated as error, aborting now)
Exiting...
make[3]: *** [docs/doxygen/xml/index.xml] Error 1
make[2]: *** [docs/CMakeFiles/Doxygen.dir/all] Error 2
make[1]: *** [docs/CMakeFiles/Doxygen.dir/rule] Error 2
make: *** [Doxygen] Error 2

The RTD builds the docs post-merge and will update the README badge but we seem to need a pre-merge CI check to catch these regressions too.

@kokkos-devops-admin
Copy link

Status Flag 'Pre-Test Inspection' - Auto Inspected - Inspection Is Not Necessary for this Pull Request.

@kokkos-devops-admin
Copy link

Status Flag 'Pull Request AutoTester' - Testing Jenkins Projects:

Pull Request Auto Testing STARTING (click to expand)

Build Information

Test Name: KokkosKernels_PullRequest_GCC930_Light_Tpls_GCC930

  • Build Num: 108
  • Status: STARTED

Jenkins Parameters

Parameter Name Value
KOKKOSKERNELS_SOURCE_BRANCH fix_docs_build
KOKKOSKERNELS_SOURCE_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_SOURCE_SHA e013a71
KOKKOSKERNELS_TARGET_BRANCH develop
KOKKOSKERNELS_TARGET_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_TARGET_SHA 9acf300
PR_LABELS
PULLREQUESTNUM 1569
TEST_REPO_ALIAS KOKKOSKERNELS

Build Information

Test Name: KokkosKernels_PullRequest_CUDA11_CUDA11_LayoutRight

  • Build Num: 116
  • Status: STARTED

Jenkins Parameters

Parameter Name Value
KOKKOSKERNELS_SOURCE_BRANCH fix_docs_build
KOKKOSKERNELS_SOURCE_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_SOURCE_SHA e013a71
KOKKOSKERNELS_TARGET_BRANCH develop
KOKKOSKERNELS_TARGET_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_TARGET_SHA 9acf300
PR_LABELS
PULLREQUESTNUM 1569
TEST_REPO_ALIAS KOKKOSKERNELS

Build Information

Test Name: KokkosKernels_PullRequest_GCC1020

  • Build Num: 69
  • Status: STARTED

Jenkins Parameters

Parameter Name Value
KOKKOSKERNELS_SOURCE_BRANCH fix_docs_build
KOKKOSKERNELS_SOURCE_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_SOURCE_SHA e013a71
KOKKOSKERNELS_TARGET_BRANCH develop
KOKKOSKERNELS_TARGET_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_TARGET_SHA 9acf300
PR_LABELS
PULLREQUESTNUM 1569
TEST_REPO_ALIAS KOKKOSKERNELS

Build Information

Test Name: KokkosKernels_PullRequest_GCC1020_Light_LayoutRight

  • Build Num: 68
  • Status: STARTED

Jenkins Parameters

Parameter Name Value
KOKKOSKERNELS_SOURCE_BRANCH fix_docs_build
KOKKOSKERNELS_SOURCE_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_SOURCE_SHA e013a71
KOKKOSKERNELS_TARGET_BRANCH develop
KOKKOSKERNELS_TARGET_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_TARGET_SHA 9acf300
PR_LABELS
PULLREQUESTNUM 1569
TEST_REPO_ALIAS KOKKOSKERNELS

Build Information

Test Name: KokkosKernels_PullRequest_Tpls_GCC1020

  • Build Num: 31
  • Status: STARTED

Jenkins Parameters

Parameter Name Value
KOKKOSKERNELS_SOURCE_BRANCH fix_docs_build
KOKKOSKERNELS_SOURCE_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_SOURCE_SHA e013a71
KOKKOSKERNELS_TARGET_BRANCH develop
KOKKOSKERNELS_TARGET_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_TARGET_SHA 9acf300
PR_LABELS
PULLREQUESTNUM 1569
TEST_REPO_ALIAS KOKKOSKERNELS

Build Information

Test Name: KokkosKernels_PullRequest_Tpls_INTEL19

  • Build Num: 118
  • Status: STARTED

Jenkins Parameters

Parameter Name Value
KOKKOSKERNELS_SOURCE_BRANCH fix_docs_build
KOKKOSKERNELS_SOURCE_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_SOURCE_SHA e013a71
KOKKOSKERNELS_TARGET_BRANCH develop
KOKKOSKERNELS_TARGET_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_TARGET_SHA 9acf300
PR_LABELS
PULLREQUESTNUM 1569
TEST_REPO_ALIAS KOKKOSKERNELS

Build Information

Test Name: KokkosKernels_PullRequest_CLANG1001

  • Build Num: 167
  • Status: STARTED

Jenkins Parameters

Parameter Name Value
KOKKOSKERNELS_SOURCE_BRANCH fix_docs_build
KOKKOSKERNELS_SOURCE_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_SOURCE_SHA e013a71
KOKKOSKERNELS_TARGET_BRANCH develop
KOKKOSKERNELS_TARGET_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_TARGET_SHA 9acf300
PR_LABELS
PULLREQUESTNUM 1569
TEST_REPO_ALIAS KOKKOSKERNELS

Build Information

Test Name: KokkosKernels_PullRequest_CLANG13CUDA10

  • Build Num: 57
  • Status: STARTED

Jenkins Parameters

Parameter Name Value
KOKKOSKERNELS_SOURCE_BRANCH fix_docs_build
KOKKOSKERNELS_SOURCE_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_SOURCE_SHA e013a71
KOKKOSKERNELS_TARGET_BRANCH develop
KOKKOSKERNELS_TARGET_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_TARGET_SHA 9acf300
PR_LABELS
PULLREQUESTNUM 1569
TEST_REPO_ALIAS KOKKOSKERNELS

Build Information

Test Name: KokkosKernels_PullRequest_Tpls_ARMPL2110_Tpls_ARMPL2030_GCC1020

  • Build Num: 61
  • Status: STARTED

Jenkins Parameters

Parameter Name Value
KOKKOSKERNELS_SOURCE_BRANCH fix_docs_build
KOKKOSKERNELS_SOURCE_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_SOURCE_SHA e013a71
KOKKOSKERNELS_TARGET_BRANCH develop
KOKKOSKERNELS_TARGET_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_TARGET_SHA 9acf300
PR_LABELS
PULLREQUESTNUM 1569
TEST_REPO_ALIAS KOKKOSKERNELS

Using Repos:

Repo: KOKKOSKERNELS (kokkos/kokkos-kernels)
  • Branch: fix_docs_build
  • SHA: e013a71
  • Mode: TEST_REPO

Pull Request Author: e10harvey

ndellingwood
ndellingwood approved these changes Oct 24, 2022
View reviewed changes
Copy link
Contributor

@ndellingwood ndellingwood left a comment

Choose a reason for hiding this comment

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

Changes look reasonable, thanks @e10harvey !

@kokkos-devops-admin
Copy link

Status Flag 'Pull Request AutoTester' - Jenkins Testing: all Jobs PASSED

Pull Request Auto Testing has PASSED (click to expand)

Build Information

Test Name: KokkosKernels_PullRequest_GCC930_Light_Tpls_GCC930

  • Build Num: 108
  • Status: PASSED

Jenkins Parameters

Parameter Name Value
KOKKOSKERNELS_SOURCE_BRANCH fix_docs_build
KOKKOSKERNELS_SOURCE_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_SOURCE_SHA e013a71
KOKKOSKERNELS_TARGET_BRANCH develop
KOKKOSKERNELS_TARGET_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_TARGET_SHA 9acf300
PR_LABELS
PULLREQUESTNUM 1569
TEST_REPO_ALIAS KOKKOSKERNELS

Build Information

Test Name: KokkosKernels_PullRequest_CUDA11_CUDA11_LayoutRight

  • Build Num: 116
  • Status: PASSED

Jenkins Parameters

Parameter Name Value
KOKKOSKERNELS_SOURCE_BRANCH fix_docs_build
KOKKOSKERNELS_SOURCE_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_SOURCE_SHA e013a71
KOKKOSKERNELS_TARGET_BRANCH develop
KOKKOSKERNELS_TARGET_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_TARGET_SHA 9acf300
PR_LABELS
PULLREQUESTNUM 1569
TEST_REPO_ALIAS KOKKOSKERNELS

Build Information

Test Name: KokkosKernels_PullRequest_GCC1020

  • Build Num: 69
  • Status: PASSED

Jenkins Parameters

Parameter Name Value
KOKKOSKERNELS_SOURCE_BRANCH fix_docs_build
KOKKOSKERNELS_SOURCE_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_SOURCE_SHA e013a71
KOKKOSKERNELS_TARGET_BRANCH develop
KOKKOSKERNELS_TARGET_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_TARGET_SHA 9acf300
PR_LABELS
PULLREQUESTNUM 1569
TEST_REPO_ALIAS KOKKOSKERNELS

Build Information

Test Name: KokkosKernels_PullRequest_GCC1020_Light_LayoutRight

  • Build Num: 68
  • Status: PASSED

Jenkins Parameters

Parameter Name Value
KOKKOSKERNELS_SOURCE_BRANCH fix_docs_build
KOKKOSKERNELS_SOURCE_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_SOURCE_SHA e013a71
KOKKOSKERNELS_TARGET_BRANCH develop
KOKKOSKERNELS_TARGET_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_TARGET_SHA 9acf300
PR_LABELS
PULLREQUESTNUM 1569
TEST_REPO_ALIAS KOKKOSKERNELS

Build Information

Test Name: KokkosKernels_PullRequest_Tpls_GCC1020

  • Build Num: 31
  • Status: PASSED

Jenkins Parameters

Parameter Name Value
KOKKOSKERNELS_SOURCE_BRANCH fix_docs_build
KOKKOSKERNELS_SOURCE_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_SOURCE_SHA e013a71
KOKKOSKERNELS_TARGET_BRANCH develop
KOKKOSKERNELS_TARGET_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_TARGET_SHA 9acf300
PR_LABELS
PULLREQUESTNUM 1569
TEST_REPO_ALIAS KOKKOSKERNELS

Build Information

Test Name: KokkosKernels_PullRequest_Tpls_INTEL19

  • Build Num: 118
  • Status: PASSED

Jenkins Parameters

Parameter Name Value
KOKKOSKERNELS_SOURCE_BRANCH fix_docs_build
KOKKOSKERNELS_SOURCE_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_SOURCE_SHA e013a71
KOKKOSKERNELS_TARGET_BRANCH develop
KOKKOSKERNELS_TARGET_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_TARGET_SHA 9acf300
PR_LABELS
PULLREQUESTNUM 1569
TEST_REPO_ALIAS KOKKOSKERNELS

Build Information

Test Name: KokkosKernels_PullRequest_CLANG1001

  • Build Num: 167
  • Status: PASSED

Jenkins Parameters

Parameter Name Value
KOKKOSKERNELS_SOURCE_BRANCH fix_docs_build
KOKKOSKERNELS_SOURCE_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_SOURCE_SHA e013a71
KOKKOSKERNELS_TARGET_BRANCH develop
KOKKOSKERNELS_TARGET_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_TARGET_SHA 9acf300
PR_LABELS
PULLREQUESTNUM 1569
TEST_REPO_ALIAS KOKKOSKERNELS

Build Information

Test Name: KokkosKernels_PullRequest_CLANG13CUDA10

  • Build Num: 57
  • Status: PASSED

Jenkins Parameters

Parameter Name Value
KOKKOSKERNELS_SOURCE_BRANCH fix_docs_build
KOKKOSKERNELS_SOURCE_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_SOURCE_SHA e013a71
KOKKOSKERNELS_TARGET_BRANCH develop
KOKKOSKERNELS_TARGET_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_TARGET_SHA 9acf300
PR_LABELS
PULLREQUESTNUM 1569
TEST_REPO_ALIAS KOKKOSKERNELS

Build Information

Test Name: KokkosKernels_PullRequest_Tpls_ARMPL2110_Tpls_ARMPL2030_GCC1020

  • Build Num: 61
  • Status: PASSED

Jenkins Parameters

Parameter Name Value
KOKKOSKERNELS_SOURCE_BRANCH fix_docs_build
KOKKOSKERNELS_SOURCE_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_SOURCE_SHA e013a71
KOKKOSKERNELS_TARGET_BRANCH develop
KOKKOSKERNELS_TARGET_REPO https://github.com/kokkos/kokkos-kernels
KOKKOSKERNELS_TARGET_SHA 9acf300
PR_LABELS
PULLREQUESTNUM 1569
TEST_REPO_ALIAS KOKKOSKERNELS

@kokkos-devops-admin
Copy link

Status Flag 'Pre-Merge Inspection' - SUCCESS: The last commit to this Pull Request has been INSPECTED AND APPROVED by [ ndellingwood ]!

@kokkos-devops-admin
Copy link

Status Flag 'Pull Request AutoTester' - Pull Request MUST BE MERGED MANUALLY BY Project Team - This Repo does not support Automerge

@ndellingwood ndellingwood merged commit 8b240c3 into develop Oct 24, 2022
@e10harvey e10harvey deleted the fix_docs_build branch November 3, 2022 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ndellingwood ndellingwood ndellingwood approved these changes

@lucbv lucbv Awaiting requested review from lucbv

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@e10harvey @kokkos-devops-admin @ndellingwood