include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
include($QT_INSTALL_DOCS/global/externalsites.qdocconf)


project                 = QtDoc
description             = Qt Reference Documentation
version                 = $QT_VERSION

# Instruct Clang not to look for a module header
moduleheader =

# Depend on everything - load all available index files
depends = *

headerdirs  += ../src
imagedirs   += ../src/images \
               ../images

sourcedirs  += \
    ../src

exampledirs += \
    ../src \
    ../snippets \
    ../../examples

excludedirs += \
    ../src/snippets \
    ../src/cmake \
    ../src/platformintegration

# include java files in the list of example sources
examples.fileextensions =+ *.java

# Exclude documentation for the broken examples
excludefiles += \
    ../../examples/demos/maroon/doc/src/maroon.qdoc \
    ../../examples/demos/samegame/doc/src/samegame.qdoc \
    ../../examples/demos/tweetsearch/doc/src/tweetsearch.qdoc

examplesinstallpath =

qhp.projects            = QtDoc

qhp.QtDoc.file                = qtdoc.qhp
qhp.QtDoc.namespace           = org.qt-project.qtdoc.$QT_VERSION_TAG
qhp.QtDoc.virtualFolder       = qtdoc
qhp.QtDoc.indexTitle          = Qt $QT_VERSION Reference Documentation
qhp.QtDoc.indexRoot           =

qhp.QtDoc.subprojects         = classes qmltypes examples
qhp.QtDoc.subprojects.classes.title = Classes
qhp.QtDoc.subprojects.classes.indexTitle = All Classes
qhp.QtDoc.subprojects.classes.selectors = class fake:headerfile
qhp.QtDoc.subprojects.classes.sortPages = true
qhp.QtDoc.subprojects.qmltypes.title = QML Types
qhp.QtDoc.subprojects.qmltypes.indexTitle = All QML Types
qhp.QtDoc.subprojects.qmltypes.selectors = qmlclass
qhp.QtDoc.subprojects.qmltypes.sortPages = true
qhp.QtDoc.subprojects.examples.title = Tutorials and Examples
qhp.QtDoc.subprojects.examples.indexTitle = Qt Examples And Tutorials
qhp.QtDoc.subprojects.examples.selectors = fake:example
qhp.QtDoc.subprojects.examples.sortPages = true

# Add an image used in example manifests to qhp, as well as thumbnails for YouTube links
{HTML.extraimages,qhp.QtDoc.extraFiles} += \
    images/qt-codesample.png \
    images/yIv0vO8B7tQ.jpg \
    images/5OiIqFTjUZI.jpg

# Add an .html file with sidebar content, used in the online style
HTML.stylesheets             += style/qt5-sidebar.html

macro.indextitle              = "\\title Qt $QT_VER"
macro.qtver                   = "$QT_VER"
macro.qtmajorversion          = "$QT_VER"
macro.qtmajorversion.match    = "^(\\d+)"

macro.qt5 = "\\l{https://doc.qt.io/qt-5/\1}{\2}"
macro.qtbug = "\\l{https://bugreports.qt.io/browse/\1}{\1}"

manifestmeta.highlighted.names = "QtDoc/Coffee Machine Example" \
                                 "QtDoc/Qt Quick Demo - Same Game" \
                                 "QtDoc/Qt Quick Demo - Calqlatr"

manifestmeta.filters += coffeemachine
manifestmeta.coffeemachine.names = "QtDoc/Coffee Machine Example"
manifestmeta.coffeemachine.tags = quick,embedded

# Include 'Qt for Education' pages
include(../edu/config/qtforeducation.qdocconf)

# Fail the documentation build if there are more warnings than the limit
warninglimit = 0

