AI/rocm-systems
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add configs for read the docs

Browse Source 
add handbook, user, install, and integration guides

Change-Id: I996f6909f4fdf76910981c0224f5a0266907e27a

remove old documentation steps

Change-Id: Icfad09926e67a2dfa1de0e182fc3cd534f0448f7

formatting fixes

Change-Id: I704bbbbf6ad384178f804e4a3f5e621f9c3d33b9
This commit is contained in:
Sam Wu
2023-05-02 08:54:06 -06:00
parent 8e686daa7d
commit 1335d19020
31 changed files with 1639 additions and 101 deletions
Download Patch File Download Diff File Expand all files Collapse all files
client/CMakeLists.txt
-35
View File
@@ -121,41 +121,6 @@ install(DIRECTORY ${PROJECT_SOURCE_DIR}/authentication
DESTINATION ${CMAKE_INSTALL_LIBEXECDIR}/${RDC}
COMPONENT ${CLIENT_COMPONENT})
# Generate Doxygen documentation for client api manual
find_package(Doxygen)
find_package(LATEX COMPONENTS PDFLATEX)
if(DOXYGEN_FOUND AND LATEX_FOUND)
set(RDC_MANUAL_NAME "RDC_API_Manual")
message("Building ${RDC_MANUAL_NAME}.pdf")
configure_file(${PROJECT_SOURCE_DIR}/docs/rdc_doxygen.cfg
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/latex/refman.tex
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
DEPENDS ${PROJECT_SOURCE_DIR}/docs/rdc_doxygen.cfg
"${PROJECT_SOURCE_DIR}/include/rdc/rdc.h"
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/latex/refman.pdf
COMMAND make > /dev/null
COMMAND cp ${CMAKE_CURRENT_BINARY_DIR}/latex/refman.pdf
${PROJECT_SOURCE_DIR}/docs/${RDC_MANUAL_NAME}_new.pdf
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/latex/refman.tex
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/latex)
add_custom_target(docs DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/latex/refman.pdf)
add_dependencies(${CLIENT_LIB} docs)
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/latex/refman.pdf
DESTINATION ${CMAKE_INSTALL_DOCDIR}
COMPONENT ${CLIENT_COMPONENT} RENAME ${RDC_MANUAL_NAME}.pdf)
install(FILES ${PROJECT_SOURCE_DIR}/README.md
DESTINATION ${CMAKE_INSTALL_DOCDIR}
COMPONENT ${CLIENT_COMPONENT})
else()
message("Doxygen or Latex is not found. Will not generate documents.")
endif(DOXYGEN_FOUND AND LATEX_FOUND)
message("&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&")
message(" Finished Cmake Client Lib ")
message("&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&")