Skip to content
Snippets Groups Projects
Commit 0dd70420 authored by Lars Bilke's avatar Lars Bilke
Browse files

[docs] Use FindDoxygen.cmake instead of own Doxyfile. 

https://cmake.org/cmake/help/latest/module/FindDoxygen.html
parent de8b5c48
No related branches found
No related tags found
No related merge requests found
Expand all Hide whitespace changes
Inline Side-by-side
CMakeLists.txt
+ 1
− 1
View file @ 0dd70420
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
##################### #####################
# Specify minimum CMake version # Specify minimum CMake version
cmake_minimum_required(VERSION 3.8) cmake_minimum_required(VERSION 3.9)
# Set CMake policies # Set CMake policies
cmake_policy(SET CMP0011 NEW) cmake_policy(SET CMP0011 NEW)
......
Documentation/Doxyfile.in deleted 100644 → 0
+ 0
− 2410
View file @ de8b5c48
This diff is collapsed.
scripts/cmake/DocumentationSetup.cmake
+ 74
− 69
View file @ 0dd70420
if(DOXYGEN_FOUND) if(NOT DOXYGEN_FOUND)
return()
option(DOCS_GENERATE_DOCSET "Generate Dash Docsets." OFF) endif()
set(DOT_FOUND "NO")
if(DOXYGEN_DOT_FOUND)
set(DOT_FOUND "YES")
endif()
add_custom_target(doc ${DOXYGEN_EXECUTABLE} ${PROJECT_BINARY_DIR}/Doxyfile
WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
COMMENT "Generating source code documentation with Doxygen." VERBATIM)
# Defaults
set(DOCS_GENERATE_TREEVIEW_STRING "YES" CACHE INTERNAL "")
set(DOCS_DISABLE_INDEX_STRING "NO" CACHE INTERNAL "")
set(DOCS_GENERATE_DOCSET_STRING "NO" CACHE INTERNAL "")
set(DOCS_SEARCHENGINE_STRING "YES" CACHE INTERNAL "")
# Dash Docsets # Fix for https://github.com/doxygen/doxygen/issues/6725
if(DOCS_GENERATE_DOCSET) set(DOXYGEN_LATEX_MAKEINDEX_CMD "makeindex")
find_program(DOCSETUTIL_TOOLPATH docsetutil
PATH /Applications/Xcode.app/Contents/Developer/usr/bin)
if(NOT DOCSETUTIL_TOOLPATH)
message(FATAL_ERROR "docsetutil required for Docset-generation!")
endif()
set(DOCS_GENERATE_TREEVIEW_STRING "NO" CACHE INTERNAL "")
set(DOCS_DISABLE_INDEX_STRING "YES" CACHE INTERNAL "")
set(DOCS_GENERATE_DOCSET_STRING "YES" CACHE INTERNAL "")
set(DOCS_SEARCHENGINE_STRING "NO" CACHE INTERNAL "")
add_custom_command(TARGET doc POST_BUILD
COMMAND make
COMMAND mv org.doxygen.Project.docset ogs6.docset
WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/docs
COMMENT "Generating docset ...")
configure_file(Documentation/DocsetFeed.xml.in ${PROJECT_BINARY_DIR}/docs/ogs6.xml)
endif()
if(IS_CI) set(DOXYGEN_EXCLUDE
set(OGS_DOXYGEN_LOGFILE "${PROJECT_BINARY_DIR}/DoxygenWarnings.log" CACHE INTERNAL "") ${PROJECT_SOURCE_DIR}/ThirdParty
endif() ${PROJECT_SOURCE_DIR}/scripts
${PROJECT_SOURCE_DIR}/Tests
${PROJECT_SOURCE_DIR}/Documentation/ProjectFile
${PROJECT_SOURCE_DIR}/web)
set(DOXYGEN_FILE_PATTERNS *.h *.cpp *.tpp *.dox)
set(DOXYGEN_PROJECT_NAME "OGS ${OGS_VERSION}")
set(DOXYGEN_PROJECT_VERSION ${GIT_SHA1_SHORT})
set(DOXYGEN_PROJECT_LOGO ${PROJECT_SOURCE_DIR}/Documentation/OpenGeoSys-Logo.png)
set(DOXYGEN_HTML_OUTPUT ${PROJECT_BINARY_DIR}/docs)
set(DOXYGEN_EXTRACT_ALL YES)
set(DOXYGEN_EXTRACT_PRIVATE YES)
set(DOXYGEN_EXTRACT_PACKAGE YES)
set(DOXYGEN_EXTRACT_STATIC YES)
set(DOXYGEN_EXTRACT_ANON_NSPACES YES)
set(DOXYGEN_SORT_BY_SCOPE_NAME YES)
set(DOXYGEN_LAYOUT_FILE ${PROJECT_SOURCE_DIR}/Documentation/DoxygenLayout.xml)
set(DOXYGEN_CITE_BIB_FILES ${PROJECT_SOURCE_DIR}/Documentation/bibliography)
set(DOXYGEN_WARN_LOGFILE ${PROJECT_BINARY_DIR}/DoxygenWarnings.log)
set(DOXYGEN_EXCLUDE_PATTERNS moc_* ui_* CMake*)
set(DOXYGEN_IMAGE_PATH ${PROJECT_SOURCE_DIR}/Documentation/images)
set(DOXYGEN_SOURCE_BROWSER YES)
set(DOXYGEN_INLINE_SOURCES YES)
set(DOXYGEN_REFERENCED_BY_RELATION YES)
set(DOXYGEN_REFERENCES_RELATION YES)
set(DOXYGEN_GENERATE_TREEVIEW YES)
set(DOXYGEN_USE_MATHAX YES)
set(DOXYGEN_MATHAX_RELPATH https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1)
set(DOXYGEN_GENERATE_LATEX NO)
set(DOXYGEN_PREDEFINED DOXYGEN_DOCU_ONLY)
set(DOXYGEN_ALIASES
"per{1} = \\1<sup>-1</sup>"
"ogs_file_param{1} = \\xrefitem ogs_file_param \"Input File Parameter\" \"List of all Input File Parameters\" \\ref ogs_file_param__\\1 \"\\1\""
"ogs_file_attr{1} = \\xrefitem ogs_file_param \"Input File Parameter\" \"List of all Input File Parameters\" \\ref ogs_file_attr__\\1 \"\\1\""
"ogs_file_special = \\xrefitem ogs_file_param \"Input File Parameter\" \"List of all Input File Parameters\" special OGS input file parameter"
"ogs_file_param_special{1} = \\xrefitem ogs_file_param \"Input File Parameter\" \"List of all Input File Parameters\" \\ref ogs_file_param__\\1 \"\\1\""
"ogs_file_attr_special{1} = \\xrefitem ogs_file_param \"Input File Parameter\" \"List of all Input File Parameters\" \\ref ogs_file_attr__\\1 \"\\1\""
"ogs_missing_documentation = \\xrefitem ogs_missing_documentation \"Missing Documentation\" \"OGS Input File Parameters&mdash;List of incomplete documentation pages\" Documentation missing/incomplete")
configure_file(Documentation/Doxyfile.in ${PROJECT_BINARY_DIR}/Doxyfile) doxygen_add_docs(doc
${PROJECT_SOURCE_DIR}/
${PROJECT_BINARY_DIR}/DocAux/dox)
if (BASH_TOOL_PATH AND PYTHON_EXECUTABLE) if (BASH_TOOL_PATH AND PYTHON_EXECUTABLE)
set(doc_use_external_tools TRUE) set(doc_use_external_tools TRUE)
else() else()
set(doc_use_external_tools FALSE) set(doc_use_external_tools FALSE)
endif() endif()
# TODO that will always transform all of the input files no matter if they changed
# maybe this behaviour can be changed to on-demand processing
add_custom_target(internal_pre_doc
${CMAKE_COMMAND}
-DPROJECT_BINARY_DIR=${PROJECT_BINARY_DIR}
-DPROJECT_SOURCE_DIR=${PROJECT_SOURCE_DIR}
-Ddoc_use_external_tools=${doc_use_external_tools}
-P ${PROJECT_SOURCE_DIR}/scripts/cmake/DocumentationProjectFile.cmake
WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
COMMENT "Generating project file documentation hierarchy." VERBATIM)
add_dependencies(doc internal_pre_doc)
# TODO that will always transform all of the input files no matter if they changed if (doc_use_external_tools)
# maybe this behaviour can be changed to on-demand processing set(data_dir "${Data_SOURCE_DIR}")
add_custom_target(internal_pre_doc add_custom_target(internal_pre_doc_qa_page
${CMAKE_COMMAND} ${BASH_TOOL_PATH}
-DPROJECT_BINARY_DIR=${PROJECT_BINARY_DIR} "${PROJECT_SOURCE_DIR}/scripts/doc/generate-project-file-doc-qa.sh"
-DPROJECT_SOURCE_DIR=${PROJECT_SOURCE_DIR} ${PROJECT_SOURCE_DIR}
-Ddoc_use_external_tools=${doc_use_external_tools} ${PROJECT_BINARY_DIR}
-P ${PROJECT_SOURCE_DIR}/scripts/cmake/DocumentationProjectFile.cmake ${data_dir}
WORKING_DIRECTORY ${PROJECT_BINARY_DIR} WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
COMMENT "Generating project file documentation hierarchy." VERBATIM) COMMENT "Generating project file documentation quality assurance pages." VERBATIM)
add_dependencies(doc internal_pre_doc) add_dependencies(doc internal_pre_doc_qa_page)
add_dependencies(internal_pre_doc_qa_page internal_pre_doc)
if (doc_use_external_tools)
set(data_dir "${Data_SOURCE_DIR}")
add_custom_target(internal_pre_doc_qa_page
${BASH_TOOL_PATH}
"${PROJECT_SOURCE_DIR}/scripts/doc/generate-project-file-doc-qa.sh"
${PROJECT_SOURCE_DIR}
${PROJECT_BINARY_DIR}
${data_dir}
WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
COMMENT "Generating project file documentation quality assurance pages." VERBATIM)
add_dependencies(doc internal_pre_doc_qa_page)
add_dependencies(internal_pre_doc_qa_page internal_pre_doc)
endif()
endif() endif()
scripts/cmake/Find.cmake
+ 1
− 12
View file @ 0dd70420
...@@ -2,18 +2,7 @@ ...@@ -2,18 +2,7 @@
### Find tools ### ### Find tools ###
###################### ######################
# Find doxygen find_package(Doxygen OPTIONAL_COMPONENTS dot)
if(WIN32)
find_program(DOXYGEN_DOT_EXECUTABLE NAMES dot
PATHS "$ENV{ProgramFiles}/Graphviz*/bin")
find_package(Doxygen QUIET)
if(DOXYGEN_DOT_PATH)
file(TO_NATIVE_PATH ${DOXYGEN_DOT_PATH} DOXYGEN_DOT_PATH)
set(DOXYGEN_DOT_PATH "\"${DOXYGEN_DOT_PATH}\"")
endif()
else()
find_package(Doxygen QUIET)
endif()
# Find gnu profiler gprof # Find gnu profiler gprof
find_program(GPROF_PATH gprof DOC "GNU profiler gprof" QUIET) find_program(GPROF_PATH gprof DOC "GNU profiler gprof" QUIET)
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment