summaryrefslogtreecommitdiffstats
path: root/src/doc
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2021-12-16 13:05:25 +0100
committerTopi Reinio <topi.reinio@qt.io>2021-12-16 13:49:32 +0100
commit3e86b62b6f865e9ed235c7ea676e9ee5b1df21e3 (patch)
tree5bd6d9d33bfeb00538a974fe77bfed5c1d1819b1 /src/doc
parent4e2ef099713247b751fcab1ea3c87514cf2ea528 (diff)
Doc: Fix CMake build configuration for doc builds
* Add src/doc into the build * Select the correct doc template for online doc builds * Move and update the online sidebar * Fix q QDoc warning in passing Pick-to: 6.3 6.2 Change-Id: Ib40e5e05de337da59b69ce950edf2e9e041af536 Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
Diffstat (limited to 'src/doc')
-rw-r--r--src/doc/CMakeLists.txt9
-rw-r--r--src/doc/config/style/qt5-sidebar.html16
-rw-r--r--src/doc/online/qtdeviceutilities.qdocconf9
-rw-r--r--src/doc/online/style/qt5-sidebar.html11
-rw-r--r--src/doc/qtdeviceutilities-project.qdocconf2
-rw-r--r--src/doc/qtdeviceutilities.qdocconf1
6 files changed, 29 insertions, 19 deletions
diff --git a/src/doc/CMakeLists.txt b/src/doc/CMakeLists.txt
index 20feded..e4a4b7f 100644
--- a/src/doc/CMakeLists.txt
+++ b/src/doc/CMakeLists.txt
@@ -1,5 +1,12 @@
add_library(DeviceUtilities INTERFACE)
target_link_libraries(DeviceUtilities INTERFACE Qt::Core)
+
+if(QT_BUILD_ONLINE_DOCS)
+ set(DOC_CONF "online/qtdeviceutilities.qdocconf")
+else()
+ set(DOC_CONF "qtdeviceutilities.qdocconf")
+endif()
+
qt_internal_add_docs(DeviceUtilities
- qtdeviceutilities.qdocconf
+ ${DOC_CONF}
)
diff --git a/src/doc/config/style/qt5-sidebar.html b/src/doc/config/style/qt5-sidebar.html
deleted file mode 100644
index 3879827..0000000
--- a/src/doc/config/style/qt5-sidebar.html
+++ /dev/null
@@ -1,16 +0,0 @@
-<div class="sectionlist normallist">
- <div class="heading">
- <h2>Qt Device Utilities</h2>
- </div>
- <ul>
- <li><a href="qtee-module-reference.html">Home</a></li>
- </ul>
-</div>
-<div class="sectionlist normallist">
- <div class="heading">
- <h2>See Also</h2>
- </div>
- <ul>
- <li><a href="https://doc.qt.io/QtForDeviceCreation">Qt for Device Creation</a></li>
- </ul>
-</div>
diff --git a/src/doc/online/qtdeviceutilities.qdocconf b/src/doc/online/qtdeviceutilities.qdocconf
new file mode 100644
index 0000000..c8e4c21
--- /dev/null
+++ b/src/doc/online/qtdeviceutilities.qdocconf
@@ -0,0 +1,9 @@
+include($QT_INSTALL_DOCS/global/qt-module-defaults-online.qdocconf)
+include(../qtdeviceutilities-project.qdocconf)
+
+# Sidebar used for online template
+HTML.stylesheets += style/qt5-sidebar.html
+
+# Turn off single-directory output mode
+HTML.nosubdirs = "false"
+HTML.outputsubdir = qtdeviceutilities
diff --git a/src/doc/online/style/qt5-sidebar.html b/src/doc/online/style/qt5-sidebar.html
new file mode 100644
index 0000000..d402ad0
--- /dev/null
+++ b/src/doc/online/style/qt5-sidebar.html
@@ -0,0 +1,11 @@
+<div class="sectionlist normallist">
+ <div class="heading">
+ <h2>Qt Device Utilities</h2>
+ </div>
+ <ul>
+ <li><a href="index.html">Home</a></li>
+ <li><a href="qtdeviceutilities-cpp-classes.html">C++ Classes</a></li>
+ <li><a href="qtdeviceutilities-qml-types.html">QML Types</a></li>
+ <li><a href="qtdeviceutilities-examples.html">Examples</a></li>
+ </ul>
+</div>
diff --git a/src/doc/qtdeviceutilities-project.qdocconf b/src/doc/qtdeviceutilities-project.qdocconf
index 78fda4c..01b1c96 100644
--- a/src/doc/qtdeviceutilities-project.qdocconf
+++ b/src/doc/qtdeviceutilities-project.qdocconf
@@ -1,5 +1,3 @@
-include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
-
project = QtDeviceUtilities
description = Qt Device Utilities $QT_VERSION
version = $QT_VERSION
diff --git a/src/doc/qtdeviceutilities.qdocconf b/src/doc/qtdeviceutilities.qdocconf
index 5b56cf1..bd38e0f 100644
--- a/src/doc/qtdeviceutilities.qdocconf
+++ b/src/doc/qtdeviceutilities.qdocconf
@@ -1,3 +1,4 @@
+include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
include(qtdeviceutilities-project.qdocconf)
# Turn off single-directory output mode