-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Signed-off-by: Clovis Durand <[email protected]>
- Loading branch information
Showing
2 changed files
with
2,512 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# | ||
# Copyright (C) 2019 Clovis Durand | ||
# | ||
# ----------------------------------------------------------------------------- | ||
|
||
# CMakeLists.txt that generates the Doxygen documentation | ||
find_package(Doxygen) | ||
option(BUILD_DOC "Build API documentation" ${DOXYGEN_FOUND}) | ||
|
||
set(doxy_main_page ${CMAKE_SOURCE_DIR}/README.md) | ||
|
||
if(DOXYGEN_FOUND) | ||
# set input and output files | ||
set(DOXYGEN_IN ${CMAKE_SOURCE_DIR}/software/docs/Doxyfile.in) | ||
set(DOXYGEN_OUT ${CMAKE_SOURCE_DIR}/software/docs/Doxyfile) | ||
|
||
# request to configure the file | ||
configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY) | ||
message("Doxygen build started") | ||
|
||
# note the option ALL which allows to build the docs together with the application | ||
add_custom_target(doc_doxygen ALL | ||
COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT} | ||
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/software/docs | ||
COMMENT "Generating API documentation with Doxygen" | ||
VERBATIM) | ||
else (DOXYGEN_FOUND) | ||
message("[WARN ] Doxygen is required to generate the doxygen documentation") | ||
endif (DOXYGEN_FOUND) | ||
|
||
set(HTML_DOCS_DIR | ||
${CMAKE_SOURCE_DIR}/software/docs/html | ||
) | ||
|
||
set(LATEX_DOCS_DIR | ||
${CMAKE_SOURCE_DIR}/software/docs/latex | ||
) | ||
|
||
set(MAN_DOCS_DIR | ||
${CMAKE_SOURCE_DIR}/software/docs/man | ||
) |
Oops, something went wrong.