Commit 0d9b2548 authored by Leena Miettinen's avatar Leena Miettinen Committed by Leena Miettinen

Doc: remove support for building docs with Qt 4

The templates are fetched from qtbase/doc/global

Change-Id: I15386a66e1dae552f5637062d9f176bf6565a834
Reviewed-by: default avatarOswald Buddenhagen <oswald.buddenhagen@theqtcompany.com>
Reviewed-by: default avatarEike Ziller <eike.ziller@theqtcompany.com>
Reviewed-by: default avatarJerome Pasion <jerome.pasion@digia.com>
parent c4971b6e
# Run qdoc from the directory that contains this file.
include(../config/compat.qdocconf)
include(../config/qtcreator-developer.qdocconf)
include(../config/qt-html-templates-online.qdocconf)
# Run qdoc from the directory that contains this file.
include(../config/compat.qdocconf)
include(../config/qtcreator-developer.qdocconf)
include(../config/qt-html-templates.qdocconf)
alias.i = e
macro.li = "\\o"
macro.0 = "\\\\0"
macro.b = "\\bold"
macro.n = "\\\\n"
macro.r = "\\\\r"
macro.i = "\\o"
macro.i11 = "\\o{1,1}"
macro.i12 = "\\o{1,2}"
macro.i13 = "\\o{1,3}"
macro.i14 = "\\o{1,4}"
macro.i15 = "\\o{1,5}"
macro.i16 = "\\o{1,6}"
macro.i17 = "\\o{1,7}"
macro.i18 = "\\o{1,8}"
macro.i19 = "\\o{1,9}"
macro.i21 = "\\o{2,1}"
macro.i31 = "\\o{3,1}"
macro.i41 = "\\o{4,1}"
macro.i51 = "\\o{5,1}"
macro.i61 = "\\o{6,1}"
macro.i71 = "\\o{7,1}"
macro.i81 = "\\o{8,1}"
macro.i91 = "\\o{9,1}"
macro.img = "\\image"
macro.endquote = "\\endquotation"
macro.relatesto = "\\relates"
spurious = "Missing comma in .*" \
"Missing pattern .*"
# Define the location of the templates to use. Style sheets and scripts are
# specified relative to the template directory and will be copied into
# subdirectories of the output directory.
HTML.templatedir = $SRCDIR/config
HTML.stylesheets = ../templates/style/offline.css
HTML.scripts =
# Files not referenced in any qdoc file (last four needed by qtdemo)
# See also qhp.Qt.extraFiles
# for Qt 4:
extraimages.HTML = ../templates/images/qt-logo.png \
../templates/images/arrow_down.png \
../templates/images/breadcrumb.png \
../templates/images/bullet_gt.png \
../templates/images/bullet_dn.png \
../templates/images/bullet_sq.png \
../templates/images/bullet_up.png \
../templates/images/horBar.png \
../templates/images/sprites-combined.png \
../templates/images/qtcreator-screenshots.png \
../templates/images/bgrContent.png \
../templates/images/blu_dot.png \
../templates/images/btn_next.png \
../templates/images/btn_prev.png \
../templates/images/ico_note.png \
../templates/images/ico_note_attention.png \
../templates/images/ico_out.png \
../templates/images/arrow_bc.png \
../templates/images/home.png
# for Qt 5
HTML.extraimages = ../templates/images/qt-logo.png \
../templates/images/arrow_down.png \
../templates/images/breadcrumb.png \
../templates/images/bullet_gt.png \
../templates/images/bullet_dn.png \
../templates/images/bullet_sq.png \
../templates/images/bullet_up.png \
../templates/images/horBar.png \
../templates/images/sprites-combined.png \
../templates/images/qtcreator-screenshots.png \
../templates/images/bgrContent.png \
../templates/images/blu_dot.png \
../templates/images/btn_next.png \
../templates/images/btn_prev.png \
../templates/images/ico_note.png \
../templates/images/ico_note_attention.png \
../templates/images/ico_out.png \
../templates/images/arrow_bc.png \
../templates/images/home.png
# Include the style sheets and scripts used.
HTML.headerstyles = \
" <link rel=\"stylesheet\" type=\"text/css\" href=\"style/offline.css\" />\n"
HTML.headerscripts =
HTML.endheader = \
"</head>\n" \
"<body>\n"
# Define the location of the templates to use. Style sheets and scripts are
# specified relative to the template directory and will be copied into
# subdirectories of the output directory.
HTML.templatedir = $SRCDIR/config
HTML.stylesheets = ../templates/style/narrow.css \
../templates/style/style.css \
../templates/style/style_ie6.css \
../templates/style/style_ie7.css \
../templates/style/style_ie8.css \
../templates/style/superfish.css
# Adding jquery and functions - providing online tools and search features
HTML.scripts = ../templates/scripts/functions.js \
../templates/scripts/narrow.js \
../templates/scripts/superfish.js \
../templates/scripts/jquery.js
# Files not referenced in any qdoc file.
# See also qhp.Qt.extraFiles
# for Qt 4
extraimages.HTML = ../templates/images/qt-logo.png \
../templates/images/bg_l.png \
../templates/images/bg_l_blank.png \
../templates/images/bg_ll_blank.png \
../templates/images/bg_ul_blank.png \
../templates/images/btn_next_green.png \
../templates/images/btn_prev_green.png \
../templates/images/header_bg.png \
../templates/images/bg_r.png \
../templates/images/box_bg.png \
../templates/images/breadcrumb.png \
../templates/images/btn_next_green.png \
../templates/images/btn_prev_green.png \
../templates/images/bullet_gt.png \
../templates/images/bullet_dn.png \
../templates/images/bullet_sq.png \
../templates/images/bullet_up.png \
../templates/images/arrow_down.png \
../templates/images/feedbackground.png \
../templates/images/horBar.png \
../templates/images/page.png \
../templates/images/page_bg.png \
../templates/images/sprites-combined.png \
../templates/images/spinner.gif \
../templates/images/qtcreator-screenshots.png
# for Qt 5
HTML.extraimages = ../templates/images/qt-logo.png \
../templates/images/bg_l.png \
../templates/images/bg_l_blank.png \
../templates/images/bg_ll_blank.png \
../templates/images/bg_ul_blank.png \
../templates/images/btn_next_green.png \
../templates/images/btn_prev_green.png \
../templates/images/header_bg.png \
../templates/images/bg_r.png \
../templates/images/box_bg.png \
../templates/images/breadcrumb.png \
../templates/images/btn_next_green.png \
../templates/images/btn_prev_green.png \
../templates/images/bullet_gt.png \
../templates/images/bullet_dn.png \
../templates/images/bullet_sq.png \
../templates/images/bullet_up.png \
../templates/images/arrow_down.png \
../templates/images/feedbackground.png \
../templates/images/horBar.png \
../templates/images/page.png \
../templates/images/page_bg.png \
../templates/images/sprites-combined.png \
../templates/images/spinner.gif \
../templates/images/qtcreator-screenshots.png
# Include the style sheets and scripts used.
HTML.headerstyles = \
" <link rel=\"stylesheet\" type=\"text/css\" href=\"style/style.css\" />\n" \
" <script src=\"scripts/jquery.js\" type=\"text/javascript\"></script>\n" \
" <script src=\"scripts/functions.js\" type=\"text/javascript\"></script>\n" \
" <link rel=\"stylesheet\" type=\"text/css\" href=\"style/superfish.css\" />\n" \
" <link rel=\"stylesheet\" type=\"text/css\" href=\"style/narrow.css\" />\n" \
" <!--[if IE]>\n" \
"<meta name=\"MSSmartTagsPreventParsing\" content=\"true\">\n" \
"<meta http-equiv=\"imagetoolbar\" content=\"no\">\n" \
"<![endif]-->\n" \
"<!--[if lt IE 7]>\n" \
"<link rel=\"stylesheet\" type=\"text/css\" href=\"style/style_ie6.css\">\n" \
"<![endif]-->\n" \
"<!--[if IE 7]>\n" \
"<link rel=\"stylesheet\" type=\"text/css\" href=\"style/style_ie7.css\">\n" \
"<![endif]-->\n" \
"<!--[if IE 8]>\n" \
"<link rel=\"stylesheet\" type=\"text/css\" href=\"style/style_ie8.css\">\n" \
"<![endif]-->\n\n"
HTML.headerscripts = \
"<script src=\"scripts/superfish.js\" type=\"text/javascript\"></script>\n" \
"<script src=\"scripts/narrow.js\" type=\"text/javascript\"></script>\n\n"
HTML.endheader = \
"</head>\n" \
"<body class=\"\" onload=\"CheckEmptyAndLoadList();\">\n"
include(qt-html-online-styles.qdocconf)
HTML.postheader = \
" <div class=\"header\" id=\"qtdocheader\">\n" \
" <div class=\"content\"> \n" \
" <div id=\"nav-logo\">\n" \
" <a href=\"index.html\">Home</a></div>\n" \
" <a href=\"index.html\" class=\"qtref\"><span>Qt Creator Manual</span></a>\n" \
" <div id=\"narrowsearch\"></div>\n" \
" <div id=\"nav-topright\">\n" \
" <ul>\n" \
" <li class=\"nav-topright-home\"><a href=\"http://qt.digia.com/\">Qt HOME</a></li>\n" \
" <li class=\"nav-topright-dev\"><a href=\"http://wiki.qt-project.org/\">DEV</a></li>\n" \
" <li class=\"nav-topright-doc nav-topright-doc-active\"><a href=\"http://qt-project.org/doc/\">\n" \
" DOC</a></li>\n" \
" <li class=\"nav-topright-blog\"><a href=\"http://blog.qt.digia.com/\">BLOG</a></li>\n" \
" </ul>\n" \
" </div>\n" \
" <div id=\"shortCut\">\n" \
" <ul>\n" \
" <li class=\"shortCut-topleft-inactive\"><span><a href=\"index.html\">Qt Creator</a></span></li>\n" \
" </a></li>\n" \
" </ul>\n" \
" </div>\n" \
" </div>\n" \
" </div>\n" \
" <div class=\"wrapper\">\n" \
" <div class=\"hd\">\n" \
" <span></span>\n" \
" </div>\n" \
" <div class=\"bd group\">\n" \
" <div class=\"sidebar\">\n" \
" <div class=\"box first bottombar\" id=\"lookup\">\n" \
" <h2 title=\"API Lookup\">\n" \
" API Lookup</h2>\n" \
" <div id=\"list001\" class=\"list\">\n" \
" <ul id=\"ul001\" >\n" \
" <li><a href="http://qt-project.org/doc/qt-4.8/classes.html">Class index</a></li>\n" \
" <li><a href="http://qt-project.org/doc/qt-4.8/functions.html">Function index</a></li>\n" \
" <li><a href="http://qt-project.org/doc/qt-4.8/modules.html">Modules</a></li>\n" \
" <li><a href="http://qt-project.org/doc/qt-4.8/namespaces.html">Namespaces</a></li>\n" \
" <li><a href="http://qt-project.org/doc/qt-4.8/qtglobal.html">Global Declarations</a></li>\n" \
" <li><a href="http://qt-project.org/doc/qt-4.8/qdeclarativeelements.html">QML elements</a></li>\n" \
" </ul> \n" \
" </div>\n" \
" </div>\n" \
" <div class=\"box bottombar\" id=\"topics\">\n" \
" <h2 title=\"Qt Topics\"><span></span>\n" \
" Qt Topics</h2>\n" \
" <div id=\"list002\" class=\"list\">\n" \
" <ul id=\"ul002\" >\n" \
" <li><a href="http://qt-project.org/doc/qt-4.8/qt-basic-concepts.html">Programming with Qt</a></li> \n" \
" <li><a href="http://qt-project.org/doc/qt-4.8/qtquick.html">Device UIs &amp; Qt Quick</a></li> \n" \
" <li><a href="http://qt-project.org/doc/qt-4.8/qt-gui-concepts.html">UI Design with Qt</a></li> \n" \
" <li><a href="http://qt-project.org/doc/qt-4.8/developing-with-qt.html">Cross-platform and Platform-specific</a></li> \n" \
" <li><a href="http://qt-project.org/doc/qt-4.8/platform-specific.html">Platform-specific info</a></li> \n" \
" <li><a href="http://qt-project.org/doc/qt-4.8/technology-apis.html">Qt and Key Technologies</a></li> \n" \
" <li><a href="http://qt-project.org/doc/qt-4.8/best-practices.html">Best Practices</a></li> \n" \
" </ul> \n" \
" </div>\n" \
" </div>\n" \
" <div class=\"box\" id=\"examples\">\n" \
" <h2 title=\"Examples\"><span></span>\n" \
" Examples</h2>\n" \
" <div id=\"list003\" class=\"list\">\n" \
" <ul id=\"ul003\">\n" \
" <li><a href="http://qt-project.org/doc/qt-4.8/all-examples.html">Examples</a></li>\n" \
" <li><a href="http://qt-project.org/doc/qt-4.8/tutorials.html">Tutorials</a></li>\n" \
" <li><a href="http://qt-project.org/doc/qt-4.8/demos.html">Demos</a></li>\n" \
" <li><a href="http://qt-project.org/doc/qt-4.8/qdeclarativeexamples.html">QML Examples</a></li>\n" \
" </ul> \n" \
" </div>\n" \
" </div>\n" \
" </div>\n" \
" <div class=\"wrap\">\n" \
" <div class=\"toolbar\">\n" \
" <div class=\"breadcrumb toolblock\">\n" \
" <ul>\n" \
" <li class=\"first\"><a href=\"index.html\">Home</a></li>\n" \
" <!-- Breadcrumbs go here -->\n"
HTML.postpostheader = \
" </ul>\n" \
" </div>\n" \
" <div class=\"toolbuttons toolblock\">\n" \
" <ul>\n" \
" <li id=\"smallA\" class=\"t_button\">A</li>\n" \
" <li id=\"medA\" class=\"t_button active\">A</li>\n" \
" <li id=\"bigA\" class=\"t_button\">A</li>\n" \
" <li id=\"print\" class=\"t_button\"><a href=\"javascript:this.print();\">\n" \
" <span>Print</span></a></li>\n" \
" </ul>\n" \
" </div>\n" \
" </div>\n" \
" <div class=\"content mainContent\">\n"
HTML.footer = \
" </div>\n" \
" </div>\n" \
" </div> \n" \
" <div class=\"ft\">\n" \
" <span></span>\n" \
" </div>\n" \
" </div> \n" \
" <div class=\"footer\">\n" \
" <p>\n" \
" <p>\n" \
" <acronym title=\"Copyright\">&copy;</acronym> 2014 Digia Plc and/or its\n" \
" subsidiaries. Documentation contributions included herein are the copyrights of\n" \
" their respective owners.</p>\n" \
" <br />\n" \
" <p>\n" \
" The documentation provided herein is licensed under the terms of the\n" \
" <a href=\"http://www.gnu.org/licenses/fdl.html\">GNU Free Documentation\n" \
" License version 1.3</a> as published by the Free Software Foundation.</p>\n" \
" <p>\n" \
" Documentation sources may be obtained from <a href=\"http://www.qt-project.org\">\n" \
" www.qt-project.org</a>.</p>\n" \
" <br />\n" \
" <p>\n" \
" Digia, Qt and their respective logos are trademarks of Digia Plc \n" \
" in Finland and/or other countries worldwide. All other trademarks are property\n" \
" of their respective owners. <a title=\"Privacy Policy\"\n" \
" href=\"http://en.gitorious.org/privacy_policy/\">Privacy Policy</a></p>\n" \
" </div>\n" \
"\n"
# Files not referenced in any qdoc file.
# See also extraimages.HTML
qhp.QtCreator.extraFiles = index.html \
images/bg_l.png \
images/bg_l_blank.png \
images/bg_ll_blank.png \
images/bg_ul_blank.png \
images/header_bg.png \
images/bg_r.png \
images/box_bg.png \
images/breadcrumb.png \
images/bullet_gt.png \
images/bullet_dn.png \
images/bullet_sq.png \
images/bullet_up.png \
images/arrow_down.png \
images/feedbackground.png \
images/horBar.png \
images/page.png \
images/page_bg.png \
images/sprites-combined.png \
images/spinner.gif \
images/qtcreator-screenshots.png \
scripts/functions.js \
scripts/jquery.js \
scripts/narrow.js \
scripts/superfish.js \
style/narrow.css \
style/superfish.css \
style/style_ie6.css \
style/style_ie7.css \
style/style_ie8.css \
style/style.css
include(qt-html-default-styles.qdocconf)
HTML.postheader = \
"<div class=\"header\" id=\"qtdocheader\">\n" \
" <div class=\"content\"> \n" \
" <a href=\"index.html\" class=\"qtref\"><span>Qt Creator Documentation $QTC_VERSION</span></a>\n" \
" </div>\n" \
" <div class=\"breadcrumb\">\n" \
" <ul>\n" \
" <li class=\"first\"><a href=\"index.html\">Home</a></li>\n" \
" <!-- Breadcrumbs go here -->\n"
HTML.postpostheader = \
"\n" \
" </ul>\n" \
" </div>\n" \
"</div>\n" \
"<div class=\"content mainContent\">\n"
HTML.footer = \
" <div class=\"ft\">\n" \
" <span></span>\n" \
" </div>\n" \
"</div> \n" \
"<div class=\"footer\">\n" \
" <p>\n" \
" <acronym title=\"Copyright\">&copy;</acronym> 2014 Digia Plc and/or its\n" \
" subsidiaries. Documentation contributions included herein are the copyrights of\n" \
" their respective owners.</p>\n" \
" <br />\n" \
" <p>\n" \
" The documentation provided herein is licensed under the terms of the\n" \
" <a href=\"http://www.gnu.org/licenses/fdl.html\">GNU Free Documentation\n" \
" License version 1.3</a> as published by the Free Software Foundation.</p>\n" \
" <p>\n" \
" Documentation sources may be obtained from <a href=\"http://www.qt-project.org\">\n" \
" www.qt-project.org</a>.</p>\n" \
" <br />\n" \
" <p>\n" \
" Digia, Qt and their respective logos are trademarks of Digia Plc \n" \
" in Finland and/or other countries worldwide. All other trademarks are property\n" \
" of their respective owners. <a title=\"Privacy Policy\"\n" \
" href=\"http://en.gitorious.org/privacy_policy/\">Privacy Policy</a></p>\n" \
"</div>\n" \
# Files not referenced in any qdoc file.
# See also extraimages.HTML
qhp.QtCreator.extraFiles = index.html \
images/arrow_down.png \
images/breadcrumb.png \
images/bullet_gt.png \
images/bullet_dn.png \
images/bullet_sq.png \
images/bullet_up.png \
images/horBar.png \
images/sprites-combined.png \
images/qtcreator-screenshots.png \
images/bgrContent.png \
images/blu_dot.png \
images/btn_next.png \
images/btn_prev.png \
images/ico_note.png \
images/ico_note_attention.png \
images/ico_out.png \
images/home.png \
images/arrow_bc.png \
style/offline.css
......@@ -43,7 +43,24 @@ sources.fileextensions = "*.cpp *.qdoc"
imagedirs = $SRCDIR/api/images $SRCDIR/images $SRCDIR/templates/images
outputdir = $OUTDIR
exampledirs = $SRCDIR/api/examples
indexes = qt.index
indexes += $QDOC_INDEX_DIR/qtwidgets/qtwidgets.index \
$QDOC_INDEX_DIR/qtcore/qtcore.index \
$QDOC_INDEX_DIR/qtqml/qtqml.index \
$QDOC_INDEX_DIR/qtquick/qtquick.index \
$QDOC_INDEX_DIR/qmake/qmake.index \
$QDOC_INDEX_DIR/qtdesigner/qtdesigner.index \
$QDOC_INDEX_DIR/qtdoc/qtdoc.index \
$QDOC_INDEX_DIR/qtgui/qtgui.index \
$QDOC_INDEX_DIR/qthelp/qthelp.index \
$QDOC_INDEX_DIR/qtquickcontrols/qtquickcontrols.index \
$QDOC_INDEX_DIR/qtquicklayouts/qtquicklayouts.index \
$QDOC_INDEX_DIR/qtlinguist/qtlinguist.index \
$QDOC_INDEX_DIR/qtscript/qtscript.index \
$QDOC_INDEX_DIR/qtsensors/qtsensors.index \
$QDOC_INDEX_DIR/qtuitools/qtuitools.index \
$QDOC_INDEX_DIR/qtwebkit/qtwebkit.index \
$QDOC_INDEX_DIR/qtxml/qtxml.index
include(macros.qdocconf)
include(qt-cpp-ignore.qdocconf)
......
......@@ -24,19 +24,15 @@ QHP_FILE = $$OUT_PWD/doc/html/qtcreator.qhp
QCH_FILE = $$IDE_DOC_PATH/qtcreator.qch
HELP_DEP_FILES = $$PWD/src/qtcreator.qdoc \
$$PWD/config/compat.qdocconf \
$$PWD/config/macros.qdocconf \
$$PWD/config/qt-cpp-ignore.qdocconf \
$$PWD/config/qt-defines.qdocconf \
$$PWD/config/qt-html-templates.qdocconf \
$$PWD/config/qt-html-default-styles.qdocconf \
$$PWD/qtcreator$${COMPAT}.qdocconf
$$PWD/config/qt-defines.qdocconf
html_docs.commands = $$qdoc($$OUT_PWD/doc/html) $$PWD/qtcreator$${COMPAT}.qdocconf
html_docs.commands = $$qdoc($$OUT_PWD/doc/html) $$PWD/qtcreator.qdocconf
html_docs.depends += $$HELP_DEP_FILES
html_docs.files = $$QHP_FILE
html_docs_online.commands = $$qdoc($$OUT_PWD/doc/html) $$PWD/qtcreator-online$${COMPAT}.qdocconf
html_docs_online.commands = $$qdoc($$OUT_PWD/doc/html) $$PWD/qtcreator-online.qdocconf
html_docs_online.depends += $$HELP_DEP_FILES
qch_docs.commands = $$HELPGENERATOR -o \"$$QCH_FILE\" $$QHP_FILE
......@@ -57,12 +53,14 @@ DEV_HELP_DEP_FILES = \
$$PWD/api/plugin-metadata.qdoc \
$$PWD/api/plugin-lifecycle.qdoc \
$$PWD/api/pluginmanager.qdoc \
$$PWD/api/qtcreator-dev$${COMPAT}.qdocconf
$$PWD/api/qtcreator-documentation.qdoc \
$$PWD/api/qtcreator-ui-text.qdoc \
$$PWD/api/qtcreator-dev.qdocconf
dev_html_docs.commands = $$qdoc($$OUT_PWD/doc/html-dev) $$PWD/api/qtcreator-dev$${COMPAT}.qdocconf
dev_html_docs.commands = $$qdoc($$OUT_PWD/doc/html-dev) $$PWD/api/qtcreator-dev.qdocconf
dev_html_docs.depends += $$DEV_HELP_DEP_FILES
dev_html_docs_online.commands = $$qdoc($$OUT_PWD/doc/html-dev) $$PWD/api/qtcreator-dev-online$${COMPAT}.qdocconf
dev_html_docs_online.commands = $$qdoc($$OUT_PWD/doc/html-dev) $$PWD/api/qtcreator-dev-online.qdocconf
dev_html_docs_online.depends += $$DEV_HELP_DEP_FILES
dev_qch_docs.commands = $$HELPGENERATOR -o \"$$DEV_QCH_FILE\" $$DEV_QHP_FILE
......
# Run qdoc from the directory that contains this file.
include(config/compat.qdocconf)
include(config/qtcreator-project.qdocconf)
include(config/qt-html-templates-online.qdocconf)
# Run qdoc from the directory that contains this file.
include(config/compat.qdocconf)
include(config/qtcreator-project.qdocconf)
include(config/qt-html-templates.qdocconf)
/* START non link areas where cursor should change to pointing hand */
$('.t_button').mouseover(function() {
$('.t_button').css('cursor','pointer');
/*document.getElementById(this.id).style.cursor='pointer';*/
});
/* END non link areas */
$('#smallA').click(function() {
$('.content .heading,.content h1, .content h2, .content h3, .content p, .content li, .content table').css('font-size','smaller');
$('.t_button').removeClass('active')
$(this).addClass('active')
});
$('#medA').click(function() {
$('.content .heading').css('font','600 16px/1 Arial');
$('.content h1').css('font','600 18px/1.2 Arial');
$('.content h2').css('font','600 16px/1.2 Arial');
$('.content h3').css('font','600 14px/1.2 Arial');
$('.content p').css('font','13px/20px Verdana');
$('.content li').css('font','400 13px/1 Verdana');
$('.content li').css('line-height','14px');
$('.content .toc li').css('font', 'normal 10px/1.2 Verdana');
$('.content table').css('font','13px/1.2 Verdana');
$('.content .heading').css('font','600 16px/1 Arial');