refactor: Clean up docs folder

- Completely remove mkdocs - Improve Doxygen layout
KDAB · Jul 22, 2024 · f3994bf · f3994bf
1 parent 9224e0d
commit f3994bf
Show file tree

Hide file tree

Showing 15 changed files with 14 additions and 206 deletions.
diff --git a/docs/api/CMakeLists.txt b/docs/api/CMakeLists.txt
@@ -30,10 +30,10 @@ add_custom_target(
     docs
     # Execute Doxygen
     COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
-    COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/mkdocs ${DOXYGEN_OUTPUT_DIR}/mkdocs
+    COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/docs ${DOXYGEN_OUTPUT_DIR}/docs
     # copy some files by-hand that are referred to by the markdown README.
     COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_SOURCE_DIR}/LICENSES/MIT.txt
-            ${DOXYGEN_OUTPUT_DIR}/mkdocs/docs/license.md
+            ${DOXYGEN_OUTPUT_DIR}/docs/license.md
     DEPENDS ${_dox_deps} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
     WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
     COMMENT "Building Documentation"

diff --git a/docs/api/Doxyfile.cmake b/docs/api/Doxyfile.cmake
@@ -815,7 +815,7 @@ FILE_VERSION_FILTER    =
 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
 # tag is left empty.
 
-# LAYOUT_FILE            = @CMAKE_CURRENT_SOURCE_DIR@/DoxygenLayout.xml
+LAYOUT_FILE            = @CMAKE_CURRENT_SOURCE_DIR@/DoxygenLayout.xml
 
 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
 # the reference definitions. This must be a list of .bib files. The .bib
@@ -943,9 +943,14 @@ WARN_LOGFILE           = doxygen.log
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
+                         # The order is important here, as it defines in what order the
+                         # pages show up in the "Getting Started" guide.
 INPUT                  = "@CMAKE_SOURCE_DIR@/README.md" \
                          "@CMAKE_SOURCE_DIR@/src" \
-                         "@CMAKE_SOURCE_DIR@/docs/api/mkdocs/docs/getting-started" \
+                         "@CMAKE_CURRENT_SOURCE_DIR@/docs/getting-started/index.md" \
+                         "@CMAKE_CURRENT_SOURCE_DIR@/docs/getting-started/signals-slots.md" \
+                         "@CMAKE_CURRENT_SOURCE_DIR@/docs/getting-started/properties.md" \
+                         "@CMAKE_CURRENT_SOURCE_DIR@/docs/getting-started/data-binding.md" \
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

diff --git a/docs/api/DoxygenLayout.xml b/docs/api/DoxygenLayout.xml
@@ -1,10 +1,11 @@
 <doxygenlayout version="1.0">
   <navindex>
     <tab type="mainpage" visible="yes" title="Home"/>
-    <tab type="pages" visible="yes" title="Getting Started"/>
+    <tab type="pages" visible="yes" title="Getting Started" intro="Get Started with KDBindings by learning about the concepts"/>
     <tab type="modules" visible="yes" title="Modules"/>
-    <tab type="namespaces" visible="yes" title="Namespaces"/>
-    <tab type="classes" visible="yes" title="Classes"/>
-    <tab type="files" visible="yes" title="Files"/>
+    <tab type="user" visible="yes" title="Namespace" url="@ref KDBindings"/>
+    <tab type="classlist" visible="yes" title="Classes"/>
+    <tab type="examples" visible="yes" title=""/>
+    <tab type="filelist" visible="yes" title="Files"/>
   </navindex>
 </doxygenlayout>
diff --git a/...docs/docs/getting-started/data-binding.md → .../api/docs/getting-started/data-binding.md b/...docs/docs/getting-started/data-binding.md → .../api/docs/getting-started/data-binding.md
diff --git a/.../api/mkdocs/docs/getting-started/index.md → docs/api/docs/getting-started/index.md b/.../api/mkdocs/docs/getting-started/index.md → docs/api/docs/getting-started/index.md
diff --git a/...mkdocs/docs/getting-started/properties.md → docs/api/docs/getting-started/properties.md b/...mkdocs/docs/getting-started/properties.md → docs/api/docs/getting-started/properties.md
diff --git a/...ocs/docs/getting-started/signals-slots.md → ...api/docs/getting-started/signals-slots.md b/...ocs/docs/getting-started/signals-slots.md → ...api/docs/getting-started/signals-slots.md
diff --git a/docs/api/doxybook/config.json b/docs/api/doxybook/config.json
diff --git a/docs/api/mkdocs/docs/.gitkeep b/docs/api/mkdocs/docs/.gitkeep
diff --git a/docs/api/mkdocs/docs/assets/assets_logo_tree.svg b/docs/api/mkdocs/docs/assets/assets_logo_tree.svg
diff --git a/docs/api/mkdocs/docs/assets/transparentWhiteKDAB.svg b/docs/api/mkdocs/docs/assets/transparentWhiteKDAB.svg
diff --git a/docs/api/mkdocs/docs/javascripts/config.js b/docs/api/mkdocs/docs/javascripts/config.js
diff --git a/docs/api/mkdocs/docs/stylesheets/kdab.css b/docs/api/mkdocs/docs/stylesheets/kdab.css
diff --git a/docs/api/mkdocs/mkdocs.yml.cmake b/docs/api/mkdocs/mkdocs.yml.cmake
diff --git a/docs/api/mkdocs/requirements.txt b/docs/api/mkdocs/requirements.txt