AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc: Add a define for online and offline documentation templates

Browse Source 
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>
This commit is contained in:
Topi Reinio 2018-06-29 15:14:07 +02:00 committed by Tor Arne Vestbø
parent 37a1c6dc4c
commit f4d9dadabb
2 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/global/qt-html-templates-offline.qdocconf
View File

@ -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"

2
doc/global/qt-html-templates-online.qdocconf
View File

@ -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"