summaryrefslogtreecommitdiffstats
path: root/doc/config/qtdoc.qdocconf
blob: 584b95ee3c59223dd93cea97985e488c84aaeb9d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
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 =

depends += \
    activeqt \
    qtcmake \
    qdoc \
    qmake \
    qtandroidextras \
    qtassistant \
    qtbluetooth \
    qtconcurrent \
    qtcore \
    qtdbus \
    qtdesigner \
    qtgamepad \
    qtgraphicaleffects \
    qthelp \
    qtimageformats \
    qtgui \
    qtlinguist \
    qtlocation \
    qtlottieanimation \
    qtmacextras \
    qtmultimedia \
    qtnetwork \
    qtnfc \
    qtopengl \
    qtplatformheaders \
    qtpositioning \
    qtprintsupport \
    qtqml \
    qtqmltest \
    qtquick \
    qtquickcontrols \
    qtquickdialogs \
    qtquickextras \
    qtscript \
    qtscripttools \
    qtscxml \
    qtsensors \
    qtserialbus \
    qtserialport \
    qtsql \
    qtsvg \
    qttestlib \
    qtuitools \
    qtwebchannel \
    qtwebengine \
    qtwebsockets \
    qtwidgets \
    qtwinextras \
    qtx11extras \
    qtxml \
    qtxmlpatterns \
    qt3d \
    qtwebview \
    qtquickcontrols1 \
    qtwaylandcompositor \
    qtcharts \
    qtdatavisualization \
    qtpurchasing \
    qtvirtualkeyboard \
    qtspeech \
    qtnetworkauth \
    qtremoteobjects \
    qtdistancefieldgenerator

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

sourcedirs  += \
    ../src

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

# Don't parse files in snippets and cmake directories
excludedirs += \
    ../src/snippets \
    ../src/cmake

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.filterAttributes    = qtdoc $QT_VERSION qtrefdoc
qhp.QtDoc.customFilters.Qt.name = QtDoc $QT_VERSION
qhp.QtDoc.customFilters.Qt.filterAttributes = qtdoc $QT_VERSION
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
HTML.extraimages             += images/qt-codesample.png
qhp.QtDoc.extraFiles         += images/qt-codesample.png

# 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"

# Config to enable YouTube links in the offline documentation
HTML.extraimages += ../images/I5jasWrsxT0.jpg
qhp.QtDoc.extraFiles += ../images/I5jasWrsxT0.jpg