summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2017-11-30 12:54:57 +0100
committerTopi Reiniö <topi.reinio@qt.io>2017-12-05 12:34:09 +0000
commit2afc1a11ada5f7eba0f57085ad7a97188b40b9df (patch)
tree22c70328c58306de4905884581c5ac5c0d0a2c50
parentfa4da823161ea032bc0d2aa66291117b7dae6b42 (diff)
Doc: Fix a number of documentation issues
- Fix wrong version; docs pick up the MODULE_VERSION from qmake.conf. - Fix license documentation; qtattributionsscanner outputs to doc/, so 'sourcedirs' in qt3dstudio-project.qdocconf needs to include the root doc directory. - Remove doc build from src/Viewer/qmlviewer; this caused the documentation to be built twice. - Fix 'examplesinstallpath'. - Add sidebar (qt5-sidebar.html) with quick TOC links to online docs. Change-Id: Iafa9bee6cf34843d1355d3106adb1a3602fb61a5 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io> Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io> Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
-rw-r--r--.qmake.conf2
-rw-r--r--doc/qt3dstudio-project.qdocconf6
-rw-r--r--doc/style/qt5-sidebar.html20
-rw-r--r--src/Viewer/qmlviewer/qmlviewer.pro5
4 files changed, 25 insertions, 8 deletions
diff --git a/.qmake.conf b/.qmake.conf
index a088fffc..9e8d403c 100644
--- a/.qmake.conf
+++ b/.qmake.conf
@@ -1,5 +1,5 @@
load(qt_build_config)
-MODULE_VERSION = 5.9.0
+MODULE_VERSION = 1.0.0
CMAKE_MODULE_TESTS=-
diff --git a/doc/qt3dstudio-project.qdocconf b/doc/qt3dstudio-project.qdocconf
index 1bc47d4f..189cf4ff 100644
--- a/doc/qt3dstudio-project.qdocconf
+++ b/doc/qt3dstudio-project.qdocconf
@@ -3,7 +3,7 @@ description = Qt 3D Studio Reference Manual
version = $QT_VERSION
sources.fileextensions = "*.qdoc *.html"
-sourcedirs = ./src \
+sourcedirs = . \
../src/Viewer
headerdirs = ../src/Viewer
@@ -42,7 +42,7 @@ qhp.Qt3DStudio.subprojects.classes.sortPages = true
# Add an .html file with sidebar content, used in the online style
-#HTML.stylesheets += style/qt5-sidebar.html
+HTML.stylesheets += style/qt5-sidebar.html
# ensure all images are included
#HTML.extraimages += ./src/static/Runtime-AODistances.jpg
@@ -53,7 +53,7 @@ navigation.cppclassespage = Qt 3D Studio C++ Classes
navigation.qmltypespage = Qt 3D Studio QML Types
buildversion = "Qt 3D Studio $QT_VER Manual"
-examplesinstallpath = qtstudio3d
+examplesinstallpath = studio3d
exampledirs += ../examples/studio3d
manifestmeta.highlighted.names = \
diff --git a/doc/style/qt5-sidebar.html b/doc/style/qt5-sidebar.html
new file mode 100644
index 00000000..fb25b054
--- /dev/null
+++ b/doc/style/qt5-sidebar.html
@@ -0,0 +1,20 @@
+<div class="sectionlist normallist">
+ <div class="heading">
+ <a name="reference"></a>
+ <h2 id="reference">Qt 3D Studio</h2>
+ </div>
+ <div class="indexboxcont indexboxbar">
+ <ul>
+ <li><a href="getting-started.html">Getting Started</a></li>
+ <li><a href="qt3dstudio-studio.html">Studio</a></li>
+ <li><a href="qt3dstudio-viewer.html">Viewer</a></li>
+ <li><a href="qtstudio3d-qmlmodule.html">QML API Reference</a></li>
+ <li><a href="qtstudio3d-module.html">C++ API Reference</a></li>
+ <li><a href="qt3dstudio-runtime.html">Runtime</a></li>
+ <li><a href="qt3dstudio-file-formats.html">File Formats</a></li>
+ <li><a href="qt3dstudio-best-practices.html">Best Practices</a></li>
+ <li><a href="requirements.html">Requirements</a></li>
+ <li><a href="qtstudio3d-qml-examples.html">Examples</a></li>
+ <li><a href="copyright-notices.html">Copyright Notices</a></li>
+ </ul>
+ </div>
diff --git a/src/Viewer/qmlviewer/qmlviewer.pro b/src/Viewer/qmlviewer/qmlviewer.pro
index aefba2fd..dca7feab 100644
--- a/src/Viewer/qmlviewer/qmlviewer.pro
+++ b/src/Viewer/qmlviewer/qmlviewer.pro
@@ -28,10 +28,7 @@ LIBS += \
-lqt3dsruntime$$qtPlatformTargetSuffix() \
-lqt3dsqmlstreamer$$qtPlatformTargetSuffix()
-QMAKE_DOCS = $$absolute_path($$PWD/../../../doc/qt3dstudio.qdocconf)
-
OTHER_FILES += \
- qmldir \
- $$PWD/../../../doc/src/06-qml-reference/*
+ qmldir
load(qml_plugin)