Skip to content

Improve error reporting for missing sphinx/doxygen executable #147

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

Open
pfultz2 wants to merge 9 commits into
base: develop
Choose a base branch
from
Open

Improve error reporting for missing sphinx/doxygen executable #147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7d069fb
Dont require sphinx to be installed
pfultz2 Sep 6, 2023
a83ffe0
Dont require doxygen
pfultz2 Sep 6, 2023
99ab7b4
Fix doxygen variable name
pfultz2 Sep 7, 2023
0de0f51
Improve error message when sphinx/doxygen not found
pfultz2 Sep 7, 2023
b80ab7e
Prefix with error
pfultz2 Sep 7, 2023
b29ac85
Add closing endif
pfultz2 Sep 7, 2023
a62db2a
Remove trailing whitespace
pfultz2 Sep 7, 2023
c516055
Merge branch 'develop' into require-sphinx
pfultz2 Sep 12, 2023
7290d5c
Merge branch 'require-sphinx' into require-sphinx2
pfultz2 Sep 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions share/rocm/cmake/ROCMSphinxDoc.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,24 @@ function(rocm_add_sphinx_doc SRC_DIR)
set(USE_DOXYGEN)
endif()

set(ERROR_MSG)
if (NOT SPHINX_EXECUTABLE)
set(ERROR_MSG "Sphinx executable not found.")
elseif(USE_DOXYGEN AND NOT DOXYGEN_EXECUTABLE)
set(ERROR_MSG "Doxygen executable not found.")
endif()

if(NOT TARGET sphinx-${BUILDER})
add_custom_target(sphinx-${BUILDER})
if(ERROR_MSG)
rocm_error_target(sphinx-${BUILDER} ${ERROR_MSG})
else()
add_custom_target(sphinx-${BUILDER})
endif()
rocm_mark_as_doc(sphinx-${BUILDER})
endif()

if(ERROR_MSG)
return()
endif()

add_custom_target(
Expand All @@ -85,7 +101,6 @@ function(rocm_add_sphinx_doc SRC_DIR)
add_dependencies(sphinx-${BUILDER} ${PROJECT_NAME}-sphinx-${BUILDER})
rocm_clean_doc_output("${OUTPUT_DIR}/html")
rocm_clean_doc_output("${OUTPUT_DIR}/doctrees")
rocm_mark_as_doc(sphinx-${BUILDER})
if(PARSE_DEPENDS)
add_dependencies(sphinx-${BUILDER} ${PARSE_DEPENDS})
endif()
Expand Down
6 changes: 6 additions & 0 deletions share/rocm/cmake/ROCMUtilities.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,3 +117,9 @@ function(rocm_read_os_release OUTPUT KEYVALUE)
${_output}
PARENT_SCOPE)
endfunction()

function(rocm_error_target TARGET MESSAGE)
add_custom_target(${TARGET}
COMMAND ${CMAKE_COMMAND} -E echo "ERROR: ${MESSAGE}"
COMMAND ${CMAKE_COMMAND} -E false)
endfunction()