diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2018-05-16 14:52:18 +0200 |
|---|---|---|
| committer | Laszlo Agocs <laszlo.agocs@qt.io> | 2018-05-18 07:58:07 +0000 |
| commit | 364e33a5820b42e2b631286d9e83911c18e87cb1 (patch) | |
| tree | 8126e7bff0bf53293ab3bc862f3b2bff6ae27c7b | |
| parent | 2d604c4c5bd17102c38b42411ad5aca5dda41ba1 (diff) | |
Doc: Fix documentation issues
Update online sidebar links to runtime and type documentation.
Rename landing page to qt3dstudio-index.html. This forces qdoc
to display sidebar also for the landing page.
Add a url and a dependency to the runtime doc project, and fix
related linking issues.
Change-Id: Iad73551539238a69253386421596c3f7c036fa9f
Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
| -rw-r--r-- | doc/qt3dstudio-project.qdocconf | 3 | ||||
| -rw-r--r-- | doc/src/00-concepts.qdoc | 2 | ||||
| -rw-r--r-- | doc/src/07-file-formats/0-uia.qdoc | 2 | ||||
| -rw-r--r-- | doc/style/qt5-sidebar.html | 7 |
4 files changed, 8 insertions, 6 deletions
diff --git a/doc/qt3dstudio-project.qdocconf b/doc/qt3dstudio-project.qdocconf index 6af01354..609897b5 100644 --- a/doc/qt3dstudio-project.qdocconf +++ b/doc/qt3dstudio-project.qdocconf @@ -1,6 +1,7 @@ project = Qt3DStudio description = Qt 3D Studio Reference Manual version = $QT_VERSION +url = https://doc.qt.io/qt3dstudio sources.fileextensions = "*.qdoc *.html" sourcedirs = . \ @@ -11,7 +12,7 @@ headerdirs = ../src/Viewer # TODO: Move images to doc/images imagedirs = ./src/images -depends = qtcore qtgui qtwidgets qtqml qtquick qtmultimedia qtdoc +depends = qtcore qtgui qtwidgets qtqml qtquick qtmultimedia qtdoc qt3dstudioruntime2 qhp.projects = Qt3DStudio diff --git a/doc/src/00-concepts.qdoc b/doc/src/00-concepts.qdoc index f32a1969..aab79d91 100644 --- a/doc/src/00-concepts.qdoc +++ b/doc/src/00-concepts.qdoc @@ -29,7 +29,7 @@ /*! \keyword Qt 3D Studio \title Qt 3D Studio Index -\page index.html +\page qt3dstudio-index.html \section1 Table of Contents diff --git a/doc/src/07-file-formats/0-uia.qdoc b/doc/src/07-file-formats/0-uia.qdoc index 5b8c0dd2..47d90531 100644 --- a/doc/src/07-file-formats/0-uia.qdoc +++ b/doc/src/07-file-formats/0-uia.qdoc @@ -298,7 +298,7 @@ following (as many as you like, in any order): id-prefixed path to any element in a presentation. \li The \b{\c{attribute}} attribute must match the - \l{QML Reference: Attribute Names}{scripting name} of an attribute on that element. + \l{Attribute Names}{scripting name} of an attribute on that element. \li The \b{\c{value}} attribute must provide a Lua expression to evaluate, the result of which will be set as the value on the element. diff --git a/doc/style/qt5-sidebar.html b/doc/style/qt5-sidebar.html index fb25b054..c0e3c87e 100644 --- a/doc/style/qt5-sidebar.html +++ b/doc/style/qt5-sidebar.html @@ -8,12 +8,13 @@ <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="runtime/index.html">Runtime</a></li> + <li><a href="runtime/qt3d-runtime-qml.html">QML API Reference</a></li> + <li><a href="runtime/qt3d-runtime-cpp.html">C++ API Reference</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="experimental-features.html">Experimental Features</a></li> <li><a href="qtstudio3d-qml-examples.html">Examples</a></li> <li><a href="copyright-notices.html">Copyright Notices</a></li> </ul> |