summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2023-06-29 09:04:35 +0000
committerTopi Reiniƶ <topi.reinio@qt.io>2023-06-29 12:08:34 +0000
commit15db0935c546e0d63e6c391797754749490c9c2a (patch)
tree557d69ee007e69bcdfbcdf9de51af32966d03412 /doc
parentf607e22d59e970f5016141ee4e70c834e64658dd (diff)
Doc: Move the warninglimit configuration to doc/global
The /coin directory is not installed, so trying to include a .qdocconf file using a relative path from an (installed) global configuration will fail. Task-number: QTBUG-113326 Change-Id: I761b1a7eb19ca9d6a768f1367e30d5eaf80cb816 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'doc')
-rw-r--r--doc/global/config.qdocconf2
-rw-r--r--doc/global/warninglimit.qdocconf9
2 files changed, 10 insertions, 1 deletions
diff --git a/doc/global/config.qdocconf b/doc/global/config.qdocconf
index 136506ea46..4b5a31938d 100644
--- a/doc/global/config.qdocconf
+++ b/doc/global/config.qdocconf
@@ -36,4 +36,4 @@ qhp = true
locationinfo = false
# Include the warninglimit used for documentation testing in CI
-include(../../coin/instructions/coin_module_test_docs.qdocconf)
+include(warninglimit.qdocconf)
diff --git a/doc/global/warninglimit.qdocconf b/doc/global/warninglimit.qdocconf
new file mode 100644
index 0000000000..661240820a
--- /dev/null
+++ b/doc/global/warninglimit.qdocconf
@@ -0,0 +1,9 @@
+# Fail the documentation test build if QDoc warnings exceed the limit.
+#
+# Submodule documentation projects can increase this base limit to
+# account for known warnings, for example:
+#
+# qtcore.qdocconf:
+# warninglimit += 1
+
+warninglimit = 10