diff options
| author | Topi Reinio <topi.reinio@theqtcompany.com> | 2016-06-15 10:49:35 +0200 |
|---|---|---|
| committer | Gatis Paeglis <gatis.paeglis@qt.io> | 2016-06-15 09:34:12 +0000 |
| commit | b34857c86dccc77327989915904161f429d8d612 (patch) | |
| tree | 41f1958b6a61b32157c371581bd528536c17c7cc | |
| parent | 5dc9d19ae3c4dfedf336413f7c9f304bca80e34e (diff) | |
Doc: Minor fixes and improvements
- Capitalize section title
- Add Sidebar links for C++/QML types
- Adjust output directory for online doc builds
- Fix a typo
Change-Id: I084d78bd542ecbd442139ab42bbf8af59b0ca91b
Reviewed-by: Gatis Paeglis <gatis.paeglis@qt.io>
| -rw-r--r-- | doc/config/qtota-online.qdocconf | 1 | ||||
| -rw-r--r-- | doc/config/style/qt5-sidebar.html | 10 | ||||
| -rw-r--r-- | doc/ota.qdoc | 4 |
3 files changed, 13 insertions, 2 deletions
diff --git a/doc/config/qtota-online.qdocconf b/doc/config/qtota-online.qdocconf index 948f4a3..6c45610 100644 --- a/doc/config/qtota-online.qdocconf +++ b/doc/config/qtota-online.qdocconf @@ -3,4 +3,5 @@ include($QT_INSTALL_DOCS/global/qt-module-defaults-online.qdocconf) # sidebar used for online template HTML.stylesheets += style/qt5-sidebar.html +HTML.outputsubdir = "qtota" include(navigation.qdocconf) diff --git a/doc/config/style/qt5-sidebar.html b/doc/config/style/qt5-sidebar.html index 04e8e2c..3afc393 100644 --- a/doc/config/style/qt5-sidebar.html +++ b/doc/config/style/qt5-sidebar.html @@ -1,5 +1,15 @@ <div class="sectionlist normallist"> <div class="heading"> + <a name="ota-ref"></a> + <h2 id="ota-ref">Reference</h2> + </div> + <ul> + <li><a href="qtotaupdate-module.html">Qt OTA C++ Classes</a></li> + <li><a href="qtotaupdate-qmlmodule.html">Qt OTA QML Types</a></li> + </ul> +</div> +<div class="sectionlist normallist"> + <div class="heading"> <a name="sa-links"></a> <h2 id="sa-links">See Also</h2> </div> diff --git a/doc/ota.qdoc b/doc/ota.qdoc index c2e22ae..e0275f8 100644 --- a/doc/ota.qdoc +++ b/doc/ota.qdoc @@ -53,7 +53,7 @@ \l {https://blog.qt.io/blog/2016/05/31/over-the-air-updates-part-1-introduction/} {Over-the-Air Updates, Part 1: Introduction} - \section1 Features of the update system: + \section1 Features of the Update System \list \li Atomic Upgrades (all or nothing) - if an update did not fully complete, @@ -482,7 +482,7 @@ devices use this to verify the identitiy of an update server (server authentication). Look for \c {--tls-*} command line arguments in the output of \c {./qt-ostree --help}. - It is advised to use both GPG and TLS in hostale environments. To learn more about the + It is advised to use both GPG and TLS in hostile environments. To learn more about the security topics from the above list, consult dedicated resources. \section1 Layout of an OTA Enabled Sysroot |