Doc: Update global documentation config for Qt 6

- Set base URL path to /qt
- Define 'qt6' for use in conditionals
- Omit \since information for everything introduced
  before Qt 5
- Make use of the new expandable variables to allow
  component-specific URLs in commercial templates
- Adjust CSS for changes in QDoc's output

Change-Id: I74581f0fb49cd176f92d6451c388e7b7ddf1baa4
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
This commit is contained in:
Topi Reinio 2020-06-07 11:03:02 +02:00
parent a85c7342ad
commit 2df31c8f2e
5 changed files with 15 additions and 19 deletions

View File

@ -17,9 +17,14 @@ ignorewords += \
WebChannel \
OpenGL
# Omit \since information for items introduced before Qt 5
ignoresince = 5.0
sourcedirs += includes $$BUILDDIR
url = http://doc.qt.io/qt-5
url = https://doc.qt.io/qt
defines += qt6
# Uncomment the following two lines to generate documentation marked as \internal
# alias.internal = disable

View File

@ -1,15 +1,17 @@
# This template uses the default online template for qt.io
# and modifies it for a commercial Qt component
# URL specific to this component - override as needed
componenturl = https://www.qt.io/download/
# Start of footer - the rest is defined in the default template
HTML.footer = \
" <p class=\"qt_commercial\">Available under certain Qt licenses.<br/><a href=\"http://www.qt.io/download/\">Find out more.</a></p>\n" \
" <p class=\"qt_commercial\">Available under certain Qt licenses.<br/><a href=\"${componenturl}\" target=\"_blank\">Find out more.</a></p>\n" \
" </div>\n"
include(macros.qdocconf)
include(qt-cpp-defines.qdocconf)
include(compat.qdocconf)
#include(manifest-meta.qdocconf)
include(fileextensions.qdocconf)
include(qt-html-templates-online.qdocconf)
@ -18,7 +20,7 @@ include(config.qdocconf)
HTML.prologue = \
"<div class=\"context qt_commercial\">\n" \
"<a href=\"http://www.qt.io/download/\" title=\"Available under certain Qt licenses.\" ><h1 class=\"qt_commercial\">C</h1></a>\n"
"<a href=\"${componenturl}\" target=\"_blank\" title=\"Available under certain Qt licenses.\" ><h1 class=\"qt_commercial\">C</h1></a>\n"
# Turn off single-directory output mode
HTML.nosubdirs = "false"

View File

@ -102,7 +102,7 @@ h3.fn .name, h3.fn .type {
font-weight: 400;
}
.qmlreadonly, .qmldefault {
.qmlextra {
font-family: Courier, monospace;
margin-right: 6px;
}

View File

@ -586,13 +586,7 @@ ol.a > li{
padding: 20px 20px 20px 20px;
}
.qmldefault {
padding-left: 5px;
float: right;
color: red;
}
.qmlreadonly {
.qmlextra {
padding-left: 5px;
float: right;
color: #254117;

View File

@ -489,18 +489,13 @@ h1,h2,h3,h4,h5,h6 {
text-align:left;
padding:5px 0 0 0
}
.qmlreadonly,.qmldefault {
.qmlreadonly,.qmldefault,.qmlextra {
color:#414141;
padding:0 5px 0 5px;
font-size:0.75em;
background-color:#eee;
float:right
}
.qmlreadonly {
color:#414141
}
.qmldefault {
color:#D14141
}
.rightAlign {
padding:3px 5px 3px 10px;
text-align:right