diff options
author | Topi Reinio <topi.reinio@qt.io> | 2018-06-29 15:14:07 +0200 |
---|---|---|
committer | Tor Arne Vestbø <tor.arne.vestbo@qt.io> | 2018-09-06 12:45:23 +0000 |
commit | f4d9dadabbee7d32f135ca403f39b3c6ed1c34c8 (patch) | |
tree | 9a221105d0c9f98a42ada17d18f86340dbed402c /doc | |
parent | 37a1c6dc4c102753b20b79b9460c03ad6c6ae08e (diff) |
Doc: Add a define for online and offline documentation templates
The browser backend for offline documentation has fewer capabilities
when it comes to CSS and JavaScript support. These defines allow us
to use \if conditionals when needed:
/*!
\if defined(onlinedocs)
<Content that is rendered in online documentation>
\else
<Fallback for offline docs>
\endif
*/
Change-Id: Ia51acb937754f22f2ece2836b4fb1470bf9ade90
Reviewed-by: Martin Smith <martin.smith@qt.io>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/global/qt-html-templates-offline.qdocconf | 2 | ||||
-rw-r--r-- | doc/global/qt-html-templates-online.qdocconf | 2 |
2 files changed, 4 insertions, 0 deletions
diff --git a/doc/global/qt-html-templates-offline.qdocconf b/doc/global/qt-html-templates-offline.qdocconf index d5780a35da..f9baab9d19 100644 --- a/doc/global/qt-html-templates-offline.qdocconf +++ b/doc/global/qt-html-templates-offline.qdocconf @@ -3,6 +3,8 @@ include(html-config.qdocconf) include(html-header-offline.qdocconf) include(html-footer.qdocconf) +defines += offlinedocs + #uncomment if navigation bar is not wanted #HTML.nonavigationbar = "true" diff --git a/doc/global/qt-html-templates-online.qdocconf b/doc/global/qt-html-templates-online.qdocconf index 69c399d05a..f1437a2d9c 100644 --- a/doc/global/qt-html-templates-online.qdocconf +++ b/doc/global/qt-html-templates-online.qdocconf @@ -4,6 +4,8 @@ HTML.tocdepth = 2 include(html-header-online.qdocconf) include(html-footer-online.qdocconf) +defines += onlinedocs + #uncomment if navigation bar is not wanted #HTML.nonavigationbar = "true" |