diff --git a/docs/api/CMakeLists.txt b/docs/api/CMakeLists.txt index 2721b2d..caff412 100644 --- 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 index 2fb7f8a..5bfc6f4 100644 --- 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 index a7ad12e..708d5f0 100644 --- a/docs/api/DoxygenLayout.xml +++ b/docs/api/DoxygenLayout.xml @@ -1,10 +1,11 @@ - + - - - + + + + diff --git a/docs/api/mkdocs/docs/getting-started/data-binding.md b/docs/api/docs/getting-started/data-binding.md similarity index 100% rename from docs/api/mkdocs/docs/getting-started/data-binding.md rename to docs/api/docs/getting-started/data-binding.md diff --git a/docs/api/mkdocs/docs/getting-started/index.md b/docs/api/docs/getting-started/index.md similarity index 100% rename from docs/api/mkdocs/docs/getting-started/index.md rename to docs/api/docs/getting-started/index.md diff --git a/docs/api/mkdocs/docs/getting-started/properties.md b/docs/api/docs/getting-started/properties.md similarity index 100% rename from docs/api/mkdocs/docs/getting-started/properties.md rename to docs/api/docs/getting-started/properties.md diff --git a/docs/api/mkdocs/docs/getting-started/signals-slots.md b/docs/api/docs/getting-started/signals-slots.md similarity index 100% rename from docs/api/mkdocs/docs/getting-started/signals-slots.md rename to docs/api/docs/getting-started/signals-slots.md diff --git a/docs/api/doxybook/config.json b/docs/api/doxybook/config.json deleted file mode 100644 index 0e06bed..0000000 --- a/docs/api/doxybook/config.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "baseUrl": "", - "useFolders": false, - "indexInFolders": false, - "linkSuffix": ".md", - "mainPageInRoot": true, - "mainPageName": "index", - "filesFilter": [".h", ".hpp", ".cpp"], - "foldersToGenerate": ["classes", "files", "pages", "namespaces", "examples"], - "indexClassesName": "Classes", - "indexFilesName": "Files", - "indexGroupsName": "Modules", - "indexNamespacesName": "Namespaces", - "indexRelatedPagesName": "Pages", - "indexExamplesName": "examples" -} diff --git a/docs/api/mkdocs/docs/.gitkeep b/docs/api/mkdocs/docs/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/docs/api/mkdocs/docs/assets/assets_logo_tree.svg b/docs/api/mkdocs/docs/assets/assets_logo_tree.svg deleted file mode 100644 index 802f5e6..0000000 --- a/docs/api/mkdocs/docs/assets/assets_logo_tree.svg +++ /dev/null @@ -1,64 +0,0 @@ - - - -image/svg+xml \ No newline at end of file diff --git a/docs/api/mkdocs/docs/assets/transparentWhiteKDAB.svg b/docs/api/mkdocs/docs/assets/transparentWhiteKDAB.svg deleted file mode 100644 index e0501a9..0000000 --- a/docs/api/mkdocs/docs/assets/transparentWhiteKDAB.svg +++ /dev/null @@ -1,20 +0,0 @@ - - - - - - diff --git a/docs/api/mkdocs/docs/javascripts/config.js b/docs/api/mkdocs/docs/javascripts/config.js deleted file mode 100644 index 543f24f..0000000 --- a/docs/api/mkdocs/docs/javascripts/config.js +++ /dev/null @@ -1,22 +0,0 @@ -/* - This file is part of KDBindings. - - SPDX-FileCopyrightText: 2021 Klarälvdalens Datakonsult AB, a KDAB Group company - - SPDX-License-Identifier: MIT - - Contact KDAB at for commercial licensing options. -*/ - -window.MathJax = { - tex : { - inlineMath : [ [ "\\(", "\\)" ] ], - displayMath : [ [ "\\[", "\\]" ] ], - processEscapes : true, - processEnvironments : true - }, - options : { - ignoreHtmlClass : ".*|", - processHtmlClass : "arithmatex" - } -}; \ No newline at end of file diff --git a/docs/api/mkdocs/docs/stylesheets/kdab.css b/docs/api/mkdocs/docs/stylesheets/kdab.css deleted file mode 100644 index 8440558..0000000 --- a/docs/api/mkdocs/docs/stylesheets/kdab.css +++ /dev/null @@ -1,18 +0,0 @@ -[data-md-color-scheme="kdab"] { - --md-primary-fg-color: #0077c8; - --md-primary-fg-color--light: #208bda; - --md-primary-fg-color--dark: #0d6bad; - -} - -/* Overwrite the logo width so the logo doesn't have to be square */ -.md-header__button.md-logo img, .md-header__button.md-logo svg { - height: 1.2rem; - width: 5.22rem; -} - -/* Same overwrite for the mobile navigation */ -.md-nav__title .md-nav__button.md-logo img, .md-nav__title .md-nav__button.md-logo svg { - height: 2.4rem; - width: 10.44rem; -} diff --git a/docs/api/mkdocs/mkdocs.yml.cmake b/docs/api/mkdocs/mkdocs.yml.cmake deleted file mode 100644 index bb5e5db..0000000 --- a/docs/api/mkdocs/mkdocs.yml.cmake +++ /dev/null @@ -1,55 +0,0 @@ -site_name: KDBindings ${CMAKE_PROJECT_VERSION} - Reactive programming & data binding in C++ -site_url: https://docs.kdab.com/kdbindings/latest/ -repo_url: https://github.com/kdab/kdbindings -site_description: KDBindings Documentation - Reactive programming & data binding in C++ -site_author: Klarälvdalens Datakonsult AB (KDAB) - -theme: - name: 'material' - features: - - navigation.tabs - # Navigation.tabs.sticky is an insiders only feature - # Enable it so it might become available later - - navigation.tabs.sticky - - navigation.top - palette: - scheme: kdab - font: - text: 'Open Sans' - favicon: assets/assets_logo_tree.svg - logo: assets/transparentWhiteKDAB.svg -copyright: "Copyright © Klarälvdalens Datakonsult AB (KDAB)
The Qt, C++ and OpenGL Experts
https://www.kdab.com/" -extra: - # Disabling the generator notice is currently a - # Insiders only feature. - # Will disappear if this feature becomes publicly available - generator: false - social: - - icon: fontawesome/brands/twitter - link: https://twitter.com/kdabqt - - icon: fontawesome/brands/facebook - link: https://facebook.com/kdabqt - - icon: fontawesome/solid/envelope - link: mailto:info@kdab.com -extra_css: - - stylesheets/kdab.css -markdown_extensions: - - pymdownx.highlight: - linenums: true - - pymdownx.superfences - - toc: - permalink: true -nav: - - Home: 'index.md' - - Getting Started: - - Overview: 'getting-started/index.md' - - 'Signals & Slots': 'getting-started/signals-slots.md' - - Properties: 'getting-started/properties.md' - - 'Data Binding': 'getting-started/data-binding.md' - - Classes: 'Classes.md' - - Namespaces: 'Namespaces.md' - - Files: 'Files.md' - # examples is not capitalizedfor compatibility with - # the Github examples folder name - - Examples: 'examples.md' - - License: 'license.md' diff --git a/docs/api/mkdocs/requirements.txt b/docs/api/mkdocs/requirements.txt deleted file mode 100644 index f79c751..0000000 --- a/docs/api/mkdocs/requirements.txt +++ /dev/null @@ -1,3 +0,0 @@ -mkdocs -mkdocs-material -pymdown-extensions