Fixed website generation

Fix #506

pdi/CHANGELOG.md

@@ -18,6 +18,8 @@ and this project adheres to
 #### Fixed
 * Stop claiming to support old cmake versions we do not
   [#507](https://github.com/pdidev/pdi/issues/507)
+* Fixed website generation
+  [#506](https://github.com/pdidev/pdi/issues/506)
 
 
 ## [1.8.0] - 2024-11-28

pdi/docs/CMakeLists.txt

@@ -31,56 +31,14 @@ cmake_minimum_required(VERSION 3.16...3.29)
 
 find_package(Doxygen 1.8.17 REQUIRED OPTIONAL_COMPONENTS dot)
 
-add_custom_target(doc ALL)
-file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/html")
-
-set(DOXYGEN_AUTOLINK_SUPPORT YES)
-set(DOXYGEN_BUILTIN_STL_SUPPORT YES)
-set(DOXYGEN_DISABLE_INDEX YES)
-set(DOXYGEN_ENUM_VALUES_PER_LINE 1)
-set(DOXYGEN_EXAMPLE_PATH "${PDI_SOURCE_DIR}/.." "${PDI_SOURCE_DIR}" "${CMAKE_CURRENT_SOURCE_DIR}")
-set(DOXYGEN_EXPAND_ONLY_PREDEF YES)
-set(DOXYGEN_EXTRACT_ALL YES)
-set(DOXYGEN_EXTRACT_LOCAL_CLASSES NO)
-set(DOXYGEN_FULL_PATH_NAMES NO)
-set(DOXYGEN_GENERATE_TREEVIEW YES)
-#set(DOXYGEN_GENERATE_XML YES) # Crashes on Gitlab CI
-set(DOXYGEN_HTML_FOOTER "${CMAKE_CURRENT_SOURCE_DIR}/_template/footer.html")
-set(DOXYGEN_HTML_HEADER "${CMAKE_CURRENT_SOURCE_DIR}/_template/header.html")
-set(DOXYGEN_HTML_STYLESHEET "${CMAKE_CURRENT_SOURCE_DIR}/_template/style.css")
-set(DOXYGEN_HTML_OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/html")
-set(DOXYGEN_HTML_TIMESTAMP YES)
-set(DOXYGEN_INCLUDE_GRAPH NO)
-set(DOXYGEN_INCLUDE_PATH "${PDI_SOURCE_DIR}/include/" "${PDI_SOURCE_DIR}/src/" "${PDI_BINARY_DIR}")
-set(DOXYGEN_INCLUDED_BY_GRAPH NO)
-set(DOXYGEN_INLINE_SIMPLE_STRUCTS YES)
-set(DOXYGEN_JAVADOC_AUTOBRIEF YES)
-set(DOXYGEN_LAYOUT_FILE "${CMAKE_CURRENT_SOURCE_DIR}/_template/layout.xml")
-set(DOXYGEN_MACRO_EXPANSION YES)
-set(DOXYGEN_PREDEFINED "PDI_EXPORT=" "PDI_NO_EXPORT=" "PDI_DEPRECATED_EXPORT=")
-set(DOXYGEN_PROJECT_LOGO "${CMAKE_CURRENT_SOURCE_DIR}/_template/logo.png")
-set(DOXYGEN_PROJECT_NUMBER "${PDI_VERSION}")
-set(DOXYGEN_QT_AUTOBRIEF YES)
-set(DOXYGEN_RECURSIVE NO)
-set(DOXYGEN_SEARCHENGINE NO)
-set(DOXYGEN_SHOW_FILES NO)
-set(DOXYGEN_SHOW_INCLUDE_FILES NO)
-set(DOXYGEN_SORT_MEMBER_DOCS NO)
-set(DOXYGEN_SORT_MEMBERS_CTORS_1ST YES)
-set(DOXYGEN_TOC_INCLUDE_HEADINGS 4)
-set(DOXYGEN_TYPEDEF_HIDES_STRUCT YES)
-set(DOXYGEN_UML_LIMIT_NUM_FIELDS 20)
-set(DOXYGEN_UML_LOOK YES)
-set(DOXYGEN_WARN_NO_PARAMDOC YES)
-set(DOXYGEN_IMAGE_PATH
-		"${CMAKE_CURRENT_SOURCE_DIR}/images")
-doxygen_add_docs(doxygen_doc
+set(DOXYGEN_INPUT
 		"${CMAKE_CURRENT_SOURCE_DIR}/About.md"
 		"${CMAKE_CURRENT_SOURCE_DIR}/Concepts.md"
 		"${CMAKE_CURRENT_SOURCE_DIR}/FAQ.md"
 		"${CMAKE_CURRENT_SOURCE_DIR}/First_steps.md"
 		"${CMAKE_CURRENT_SOURCE_DIR}/How_to_create_plugin.md"
 		"${CMAKE_CURRENT_SOURCE_DIR}/Installation.md"
+		"${CMAKE_CURRENT_SOURCE_DIR}/modules.md"
 		"${CMAKE_CURRENT_SOURCE_DIR}/Plugins.md"
 		"${CMAKE_CURRENT_SOURCE_DIR}/Specification_tree_ref.md"
 		"${CMAKE_CURRENT_SOURCE_DIR}/Source_installation.md"
@@ -101,6 +59,15 @@ doxygen_add_docs(doxygen_doc
 		"${PDI_SOURCE_DIR}/../plugins/pycall/README.md"
 		"${PDI_SOURCE_DIR}/../plugins/serialize/README.md"
 		"${PDI_SOURCE_DIR}/../plugins/set_value/README.md")
-add_subdirectory(First_steps)
-add_dependencies(doc doxygen_doc)
+
+file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/html")
+string(REPLACE ";" " " DOXYGEN_INPUT_SP "${DOXYGEN_INPUT}")
+configure_file(Doxyfile "${CMAKE_CURRENT_BINARY_DIR}/Doxyfile")
+add_custom_target(doc ALL
+	Doxygen::doxygen "${CMAKE_CURRENT_BINARY_DIR}/Doxyfile"
+	WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
+	DEPENDS ${DOXYGEN_INPUT}
+)
 install(DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/html/" DESTINATION "${CMAKE_INSTALL_DOCDIR}/html")
+
+add_subdirectory(First_steps)

pdi/docs/modules.md

@@ -0,0 +1,23 @@
+# C API Reference {#modules}
+
+This is the list of functions for %PDI grouped by category
+
+<div class="directory">
+<table class="directory">
+<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span>
+\ref init_final "Initialization and finalization"
+</td><td class="desc">
+The initialization and finalization part of the API is used to setup %PDI, release its resources and check version information
+</td></tr>
+<tr id="row_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span>
+\ref annotation "Code annotation"
+</td><td class="desc">
+The code annotation API is the main interface to use in the code 
+</td></tr>
+<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span>
+\ref error "Error handling"
+</td><td class="desc">
+The error handling API supports checking the error status of %PDI
+</td></tr>
+</table>
+</div><!-- directory -->