aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2017-02-03 13:37:00 +0100
committerDominik Holland <dominik.holland@pelagicore.com>2017-02-03 13:33:22 +0000
commit9889318dd059b4e3be922b73eb4c9379f61a1ae2 (patch)
treee6db4c83a2e7d3a0f5555f57a785334a7d07d989
parent18b3b4c4f3057c982faa647bad6e9b461db0b18c (diff)
Fix documentation configuration
- Override defaults (output directory) from the Qt documentation config - Fix footer in the online doc build - Rename/move neptune-ui-online.qdocconf to avoid problems in the future - Introduce doc.pro, for use in doc builds via a super repository - Update doc base url - Bump copyright year to 2017 in doc-footer Change-Id: Ia7bf0f815cdc3182f6f373127e6408940e79337d Reviewed-by: Dominik Holland <dominik.holland@pelagicore.com>
-rw-r--r--doc/doc.pri3
-rw-r--r--doc/doc.pro2
-rw-r--r--doc/neptune-ui-project.qdocconf2
-rw-r--r--doc/neptune-ui.qdocconf2
-rw-r--r--doc/online/neptune-ui.qdocconf (renamed from doc/neptune-ui-online.qdocconf)14
5 files changed, 15 insertions, 8 deletions
diff --git a/doc/doc.pri b/doc/doc.pri
index aa3c762..13c3684 100644
--- a/doc/doc.pri
+++ b/doc/doc.pri
@@ -1,7 +1,6 @@
isEmpty(VERSION): VERSION=1.0.0
build_online_docs: {
- QMAKE_DOCS_TARGETDIR = html
- QMAKE_DOCS = $$PWD/neptune-ui-online.qdocconf
+ QMAKE_DOCS = $$PWD/online/neptune-ui.qdocconf
} else {
QMAKE_DOCS = $$PWD/neptune-ui.qdocconf
}
diff --git a/doc/doc.pro b/doc/doc.pro
new file mode 100644
index 0000000..0d8b598
--- /dev/null
+++ b/doc/doc.pro
@@ -0,0 +1,2 @@
+TEMPLATE = aux
+include(doc.pri)
diff --git a/doc/neptune-ui-project.qdocconf b/doc/neptune-ui-project.qdocconf
index 2e15eb5..2d644be 100644
--- a/doc/neptune-ui-project.qdocconf
+++ b/doc/neptune-ui-project.qdocconf
@@ -1,6 +1,6 @@
project = NeptuneUI
version = $QT_VERSION
-url = http://doc.qt.io/neptuneui
+url = http://doc.qt.io/NeptuneUI
sourcedirs += src
diff --git a/doc/neptune-ui.qdocconf b/doc/neptune-ui.qdocconf
index 6f81a65..c39cf92 100644
--- a/doc/neptune-ui.qdocconf
+++ b/doc/neptune-ui.qdocconf
@@ -9,7 +9,7 @@ HTML.footer = \
"</div>\n" \
"<div class=\"footer\">\n" \
" <p>\n" \
- " <acronym title=\"Copyright\">&copy;</acronym> 2016 Pelagicore AG.\n" \
+ " <acronym title=\"Copyright\">&copy;</acronym> 2017 Pelagicore AG.\n" \
" Documentation contributions included herein are the copyrights of\n" \
" their respective owners.<br>" \
" The documentation provided herein is licensed under the terms of the" \
diff --git a/doc/neptune-ui-online.qdocconf b/doc/online/neptune-ui.qdocconf
index 6720923..da52564 100644
--- a/doc/neptune-ui-online.qdocconf
+++ b/doc/online/neptune-ui.qdocconf
@@ -1,8 +1,9 @@
+include($QT_INSTALL_DOCS/global/qt-module-defaults-online.qdocconf)
HTML.footer = \
" </div>\n" \
" <p class=\"copy-notice\">\n" \
- " <acronym title=\"Copyright\">&copy;</acronym> 2016 Pelagicore AG.\n" \
+ " <acronym title=\"Copyright\">&copy;</acronym> 2017 Pelagicore AG.\n" \
" Documentation contributions included herein are the copyrights of\n" \
" their respective owners. " \
" The documentation provided herein is licensed under the terms of the" \
@@ -12,9 +13,14 @@ HTML.footer = \
" in Finland and/or other countries worldwide. All other trademarks are property\n" \
" of their respective owners. </p>\n"
-include($QT_INSTALL_DOCS/global/qt-module-defaults-online.qdocconf)
+# online site footer
+include($QT_INSTALL_DOCS/global/html-footer-online.qdocconf)
# Add an .html file with sidebar content, used in the online style
-HTML.stylesheets += style/qt5-sidebar.html
+#HTML.stylesheets += style/qt5-sidebar.html
+
+# override defaults for Qt module documentation
+HTML.nosubdirs = "false"
+HTML.outputsubdir = "neptune-ui"
-include(neptune-ui-project.qdocconf)
+include(../neptune-ui-project.qdocconf)