Use a global value for warning limit when testing documentation in CI
The most common limit for the maximum number of allowed documentation warnings is zero. Use a global value for 'warninglimit', adopted by all Qt module documentation projects that include the configuration from qtbase/doc/global. This allows for a temporary increase of the limit across all modules as needed - for example, when updating the QDoc binary that the CI provisions to a version that introduces new types of documentation warnings. Increase this base limit temporarily to 10 to help re-enable documentation testing in CI as it's currently disabled. Task-number: QTBUG-113326 Change-Id: I8b66951ca9324bcfaec3b5a7ec2cff544c62feb0 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
This commit is contained in:
parent
69de333e1f
commit
43ea57b901
9
coin/instructions/coin_module_test_docs.qdocconf
Normal file
9
coin/instructions/coin_module_test_docs.qdocconf
Normal file
@ -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
|
@ -34,3 +34,6 @@ qhp = true
|
||||
|
||||
# Disable writing host-specific paths into .index files
|
||||
locationinfo = false
|
||||
|
||||
# Include the warninglimit used for documentation testing in CI
|
||||
include(../../coin/instructions/coin_module_test_docs.qdocconf)
|
||||
|
@ -59,6 +59,3 @@ depends += \
|
||||
qtxml
|
||||
|
||||
navigation.landingpage = "qmake Manual"
|
||||
|
||||
# Fail the documentation build if there are more warnings than the limit
|
||||
warninglimit = 0
|
||||
|
@ -42,6 +42,3 @@ imagedirs += images
|
||||
|
||||
navigation.landingpage = "Qt Concurrent"
|
||||
navigation.cppclassespage = "Qt Concurrent C++ Classes"
|
||||
|
||||
# Fail the documentation build if there are more warnings than the limit
|
||||
warninglimit = 0
|
||||
|
@ -59,6 +59,3 @@ excludefiles += ../kernel/qtestsupport_core.cpp
|
||||
|
||||
navigation.landingpage = "Qt Core"
|
||||
navigation.cppclassespage = "Qt Core C++ Classes"
|
||||
|
||||
# Fail the documentation build if there are more warnings than the limit
|
||||
warninglimit = 0
|
||||
|
@ -65,6 +65,3 @@ navigation.cppclassespage = "Qt D-Bus C++ Classes"
|
||||
|
||||
manifestmeta.thumbnail.names = "QtDBus/D-Bus Ping Pong" \
|
||||
"QtDBus/D-Bus Complex Ping Pong"
|
||||
|
||||
# Fail the documentation build if there are more warnings than the limit
|
||||
warninglimit = 0
|
||||
|
@ -72,6 +72,3 @@ spurious += "Undocumented enum item '.*' in QGradient::Preset"
|
||||
# \svgcolor {#ffdead}
|
||||
macro.svgcolor.HTML = "<div style=\"padding:10px;color:#fff;background:\1;\"></div>"
|
||||
macro.svgcolor.DocBook = "<db:phrase role=\"color:\1\">          </db:phrase>"
|
||||
|
||||
# Fail the documentation build if there are more warnings than the limit
|
||||
warninglimit = 0
|
||||
|
@ -39,6 +39,3 @@ imagedirs += images \
|
||||
|
||||
navigation.landingpage = "Qt Network"
|
||||
navigation.cppclassespage = "Qt Network C++ Classes"
|
||||
|
||||
# Fail the documentation build if there are more warnings than the limit
|
||||
warninglimit = 0
|
||||
|
@ -64,6 +64,3 @@ qhp.QtOpenGL.subprojects.classes.sortPages = true
|
||||
|
||||
navigation.landingpage = "Qt OpenGL"
|
||||
navigation.cppclassespage = "Qt OpenGL C++ Classes"
|
||||
|
||||
# Fail the documentation build if there are more warnings than the limit
|
||||
warninglimit = 0
|
||||
|
@ -40,6 +40,3 @@ imagedirs += images \
|
||||
|
||||
navigation.landingpage = "Qt Print Support"
|
||||
navigation.cppclassespage = "Qt Print Support C++ Classes"
|
||||
|
||||
# Fail the documentation build if there are more warnings than the limit
|
||||
warninglimit = 0
|
||||
|
@ -39,6 +39,3 @@ imagedirs += images \
|
||||
|
||||
navigation.landingpage = "Qt SQL"
|
||||
navigation.cppclassespage = "Qt SQL C++ Classes"
|
||||
|
||||
# Fail the documentation build if there are more warnings than the limit
|
||||
warninglimit = 0
|
||||
|
@ -55,6 +55,3 @@ manifestmeta.thumbnail.names = "QtTestLib/Chapter *"
|
||||
|
||||
navigation.landingpage = "Qt Test"
|
||||
navigation.cppclassespage = "Qt Test C++ Classes"
|
||||
|
||||
# Fail the documentation build if there are more warnings than the limit
|
||||
warninglimit = 0
|
||||
|
@ -61,6 +61,3 @@ imagedirs += images \
|
||||
navigation.landingpage = "Qt Widgets"
|
||||
navigation.cppclassespage = "Qt Widgets C++ Classes"
|
||||
manifestmeta.highlighted.names = "QtWidgets/Qt Widgets - Application Example"
|
||||
|
||||
# Fail the documentation build if there are more warnings than the limit
|
||||
warninglimit = 0
|
||||
|
@ -38,6 +38,3 @@ navigation.cppclassespage = "Qt XML C++ Classes"
|
||||
|
||||
# Add a thumbnail for examples that do not have images
|
||||
manifestmeta.thumbnail.names = "QtXml/XML Stream Lint Example"
|
||||
|
||||
# Fail the documentation build if there are more warnings than the limit
|
||||
warninglimit = 0
|
||||
|
Loading…
Reference in New Issue
Block a user