Merge pull request #1814 from e10harvey/issue1804

.github/workflows: Summarize github-DOCS errors and warnings

.github/workflows/docs.yml

@@ -63,7 +63,21 @@ jobs:
 
       - name: build_kokkos_kernels_doxygen
         working-directory: kokkos-kernels/build
-        run: make Doxygen
+        run: |
+         echo "Redirecting full output to doxygen.out..."
+         make Doxygen > doxygen.out 2>&1 || true
+         error_ret=$(grep 'Error' doxygen.out | head -c 1) || true
+         if [ ! -z $error_ret ]; then
+          echo "---- BEGIN: Summary of errors ---- "
+          cat doxygen.out | grep -i 'error:' || true
+          echo "---- END: Summary of errors ---- "
+          echo
+          echo
+          echo "---- BEGIN: Summary of warnings ---- "
+          cat doxygen.out | grep -i 'warning:' || true
+          echo "---- END: Summary of warnings ---- "
+          exit 1
+         fi
 
       - name: build_kokkos_kernels_sphinx
         working-directory: kokkos-kernels/build

docs/Doxyfile.in

@@ -606,7 +606,7 @@ HIDE_COMPOUND_REFERENCE= NO
 # will show which file needs to be included to use the class.
 # The default value is: YES.
 
-SHOW_HEADERFILE        = YES
+# SHOW_HEADERFILE        = YES
 
 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
 # the files that are included by a file in the documentation of that file.
@@ -824,7 +824,7 @@ WARN_IF_DOC_ERROR      = YES
 # parameters have no documentation without warning.
 # The default value is: YES.
 
-WARN_IF_INCOMPLETE_DOC = YES
+# WARN_IF_INCOMPLETE_DOC = YES
 
 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
 # are documented, but have no documentation for their parameters or return
@@ -1571,7 +1571,7 @@ GENERATE_TREEVIEW      = NO
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-FULL_SIDEBAR           = NO
+# FULL_SIDEBAR           = NO
 
 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
 # doxygen will group on one line in the generated HTML documentation.
@@ -1654,7 +1654,7 @@ USE_MATHJAX            = NO
 # The default value is: MathJax_2.
 # This tag requires that the tag USE_MATHJAX is set to YES.
 
-MATHJAX_VERSION        = MathJax_2
+# MATHJAX_VERSION        = MathJax_2
 
 # When MathJax is enabled you can set the default output format to be used for
 # the MathJax output. For more details about the output format see MathJax