Doc: Add a define for online and offline documentation templates

toreinio · torarnv · commit f4d9dadabbee · 2018-09-06T12:45:23.000Z
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)
    &lt;Content that is rendered in online documentation&gt;
  \else
    &lt;Fallback for offline docs&gt;
  \endif
*/

Change-Id: Ia51acb937754f22f2ece2836b4fb1470bf9ade90
Reviewed-by: Martin Smith &lt;martin.smith@qt.io&gt;
diff --git 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
@@ -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"
 
