erki
f64a92aa5c
Now I wonder if we'll ever use it. Co-authored-by: erki <skull132@skullnet.me> Reviewed-on: #3
54 lines
2.1 KiB
CMake
54 lines
2.1 KiB
CMake
find_package(Doxygen REQUIRED)
|
|
find_package(Sphinx REQUIRED)
|
|
|
|
file(GLOB_RECURSE SKULLC_PUBLIC_HEADERS
|
|
${PROJECT_SOURCE_DIR}/Messaging/Inc/*
|
|
${PROJECT_SOURCE_DIR}/Threads/Inc/*
|
|
${PROJECT_SOURCE_DIR}/Utility/Inc/*
|
|
${PROJECT_SOURCE_DIR}/Peripherals/Inc/*
|
|
)
|
|
|
|
set(DOXYGEN_INPUT_DIRS "${PROJECT_SOURCE_DIR}/Messaging/Inc ${PROJECT_SOURCE_DIR}/Threads/Inc ${PROJECT_SOURCE_DIR}/Utility/Inc ${PROJECT_SOURCE_DIR}/Peripherals/Inc")
|
|
set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/docs/doxygen)
|
|
set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/xml/index.xml)
|
|
set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
|
|
set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
|
|
|
|
configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY)
|
|
|
|
file(MAKE_DIRECTORY ${DOXYGEN_OUTPUT_DIR}) #Doxygen won't create this for us
|
|
add_custom_command(OUTPUT ${DOXYGEN_INDEX_FILE}
|
|
DEPENDS ${SKULLC_PUBLIC_HEADERS}
|
|
COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_OUT}
|
|
MAIN_DEPENDENCY ${DOXYFILE_OUT} ${DOXYFILE_IN}
|
|
COMMENT "Generating docs"
|
|
)
|
|
|
|
add_custom_target(Doxygen ALL DEPENDS ${DOXYGEN_INDEX_FILE})
|
|
|
|
set(SPHINX_SOURCE ${CMAKE_CURRENT_SOURCE_DIR})
|
|
set(SPHINX_BUILD ${CMAKE_CURRENT_BINARY_DIR}/sphinx)
|
|
set(SPHINX_INDEX_FILE ${SPHINX_BUILD}/index.html)
|
|
file(GLOB SPHINX_RST_FILES ${SPHINX_SOURCE}/*.rst)
|
|
|
|
# Only regenerate Sphinx when:
|
|
# - Doxygen has rerun
|
|
# - Our doc files have been updated
|
|
# - The Sphinx config has been updated
|
|
add_custom_command(OUTPUT ${SPHINX_INDEX_FILE}
|
|
COMMAND
|
|
${SPHINX_EXECUTABLE} -b html
|
|
# Tell Breathe where to find the Doxygen output
|
|
-Dbreathe_projects.SkullCPeripheralsLibrary=${DOXYGEN_OUTPUT_DIR}/xml
|
|
${SPHINX_SOURCE} ${SPHINX_BUILD}
|
|
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
|
DEPENDS
|
|
# Other docs files you want to track should go here (or in some variable)
|
|
${SPHINX_RST_FILES}
|
|
${DOXYGEN_INDEX_FILE}
|
|
MAIN_DEPENDENCY ${SPHINX_SOURCE}/conf.py
|
|
COMMENT "Generating documentation with Sphinx")
|
|
|
|
# Nice named target so we can run the job easily
|
|
add_custom_target(Sphinx ALL DEPENDS ${SPHINX_INDEX_FILE})
|