summaryrefslogtreecommitdiff
path: root/doc/config
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2020-01-23 11:45:07 +0100
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2020-01-27 09:05:07 +0000
commit5fc456dd2283b2d1e6c4e6d34856052658f34cc4 (patch)
tree7a7cd26a33014e401536a149fa47f6586b68c247 /doc/config
parentc9f90047ac701416e439f492069c1a0bb364fc08 (diff)
downloadqt-creator-5fc456dd2283b2d1e6c4e6d34856052658f34cc4.tar.gz
Doc: Rearrange files in the doc folder
Source and configuration files for each manual are now located in a separate subdirectory, with common configuration files in doc/config. doc |_config |_qtcreator |_qtcreatordev |_qtdesignstudio Edit the config files accordingly. Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Diffstat (limited to 'doc/config')
-rw-r--r--doc/config/qtcreator-developer.qdocconf85
-rw-r--r--doc/config/qtcreator-project.qdocconf84
-rw-r--r--doc/config/style/qt5-sidebar.html17
3 files changed, 0 insertions, 186 deletions
diff --git a/doc/config/qtcreator-developer.qdocconf b/doc/config/qtcreator-developer.qdocconf
deleted file mode 100644
index ef4a1eb8d5..0000000000
--- a/doc/config/qtcreator-developer.qdocconf
+++ /dev/null
@@ -1,85 +0,0 @@
-project = "Qt Creator"
-description = "Extending Qt Creator Manual"
-
-language = Cpp
-
-headerdirs = . \
- ../api \
- ../../src/libs/aggregation \
- ../../src/libs/cplusplus \
- ../../src/libs/extensionsystem \
- ../../src/libs/utils \
- ../../src/libs/qmljs \
- ../../src/libs/qtcreatorcdbext \
- ../../src/plugins/coreplugin \
- ../../src/plugins/debugger \
- ../../src/plugins/vcsbase \
- ../../src/plugins/projectexplorer \
- ../../src/plugins/texteditor
-
-sourcedirs = . \
- ../api \
- ../../src/libs/aggregation \
- ../../src/libs/cplusplus \
- ../../src/libs/extensionsystem \
- ../../src/libs/utils \
- ../../src/libs/qmljs \
- ../../src/libs/qtcreatorcdbext \
- ../../src/plugins/coreplugin \
- ../../src/plugins/debugger \
- ../../src/plugins/vcsbase \
- ../../src/plugins/projectexplorer\
- ../../src/plugins/texteditor
-
-# -- Uncomment following option to generate complete documentation
-# instead of public API documentation only.
-#showinternal = true
-
-headers.fileextensions = "*.h"
-sources.fileextensions = "*.cpp *.qdoc"
-
-imagedirs = ../api/images ../images ../templates/images
-exampledirs = ../api/examples
-
-depends += qtwidgets \
- qtcore \
- qtqml \
- qtquick \
- qmake \
- qtdesigner \
- qtdoc \
- qtgui \
- qthelp \
- qtquickcontrols \
- qtlinguist \
- qtsensors \
- qtuitools \
- qtwebkit \
- qtxml
-
-include(macros.qdocconf)
-include(qt-cpp-ignore.qdocconf)
-include(qt-defines.qdocconf)
-
-qhp.projects = QtCreatorDev
-qhp.QtCreatorDev.file = qtcreator-dev.qhp
-qhp.QtCreatorDev.namespace = org.qt-project.qtcreator.developer.$QTC_VERSION_TAG
-qhp.QtCreatorDev.virtualFolder = doc
-qhp.QtCreatorDev.indexTitle = Extending Qt Creator Manual
-qhp.QtCreatorDev.filterAttributes = qtcreator $QTC_VERSION
-qhp.QtCreatorDev.customFilters.QtCreator.name = Qt Creator $QTC_VERSION
-qhp.QtCreatorDev.customFilters.QtCreator.filterAttributes = qtcreator $QTC_VERSION
-qhp.QtCreatorDev.indexRoot =
-
-qhp.QtCreator.subprojects = manual
-qhp.QtCreator.subprojects.manual.title = Creating Qt Creator Plugins
-qhp.QtCreator.subprojects.manual.indexTitle = Creating Qt Creator Plugins
-qhp.QtCreator.subprojects.manual.type = manual
-
-# Doxygen compatibility commands
-
-macro.see = "\\sa"
-macro.function = "\\fn"
-
-navigation.landingpage = "Extending Qt Creator Manual"
-buildversion = "Extending Qt Creator Manual $QTC_VERSION"
diff --git a/doc/config/qtcreator-project.qdocconf b/doc/config/qtcreator-project.qdocconf
deleted file mode 100644
index ed365b06d8..0000000000
--- a/doc/config/qtcreator-project.qdocconf
+++ /dev/null
@@ -1,84 +0,0 @@
-project = "$IDE_DISPLAY_NAME"
-description = "$IDE_DISPLAY_NAME Manual"
-url = http://doc.qt.io/$IDE_ID
-
-headerdirs =
-sourcedirs = ../src
-imagedirs = ../images \
- ../templates/images \
- ../../src/libs/qmleditorwidgets/images \
- ../../src/libs/utils/images \
- ../../src/plugins/android/images \
- ../../src/plugins/autotest/images \
- ../../src/plugins/classview/images \
- ../../src/plugins/coreplugin/images \
- ../../src/plugins/debugger/images \
- ../../src/plugins/diffeditor/images \
- ../../src/plugins/help/images \
- ../../src/plugins/projectexplorer/images \
- ../../src/plugins/qmldesigner/components/componentcore/images \
- ../../src/plugins/qmldesigner/components/formeditor \
- ../../src/plugins/qmldesigner/components/navigator \
- ../../src/plugins/qmldesigner/components/timelineeditor/images \
- ../../src/plugins/qmldesigner/qmlpreviewplugin/images \
- ../../src/plugins/scxmleditor/common/images \
- ../../src/plugins/texteditor/images \
- ../../src/plugins/valgrind/images \
- ../../src/plugins/welcome/images
-
-exampledirs = ../examples
-examples.fileextensions += *.qml *.svg
-
-HTML.extraimages = images/commercial.png
-qhp.QtCreator.extraFiles = images/commercial.png
-
-depends += qtwidgets \
- qtcmake \
- qtcore \
- qtqml \
- qtquick \
- qmake \
- qtdesigner \
- qtdoc \
- qtgui \
- qthelp \
- qtquickcontrols \
- qtquickextras \
- qtquicktimeline \
- qtlinguist \
- qtscxml \
- qtsensors \
- qttestlib \
- qtuitools \
- qtxml
-
-include(macros.qdocconf)
-include(qt-cpp-ignore.qdocconf)
-include(qt-defines.qdocconf)
-
-defines += qtcreator
-
-sources.fileextensions = "*.qdoc"
-
-qhp.projects = QtCreator
-qhp.QtCreator.file = qtcreator.qhp
-qhp.QtCreator.namespace = org.qt-project.qtcreator.$QTC_VERSION_TAG
-qhp.QtCreator.virtualFolder = doc
-qhp.QtCreator.indexTitle = $IDE_DISPLAY_NAME Manual $QTC_VERSION
-qhp.QtCreator.filterAttributes = $IDE_ID $QTC_VERSION
-qhp.QtCreator.customFilters.QtCreator.name = $IDE_DISPLAY_NAME $QTC_VERSION
-qhp.QtCreator.customFilters.QtCreator.filterAttributes = $IDE_ID $QTC_VERSION
-qhp.QtCreator.indexRoot =
-
-qhp.QtCreator.subprojects = manual
-qhp.QtCreator.subprojects.manual.title = $IDE_DISPLAY_NAME Manual
-qhp.QtCreator.subprojects.manual.indexTitle = All Topics
-qhp.QtCreator.subprojects.manual.type = manual
-
-# Doxygen compatibility commands
-
-macro.see = "\\sa"
-macro.function = "\\fn"
-
-navigation.landingpage = "$IDE_DISPLAY_NAME Manual"
-buildversion = "$IDE_DISPLAY_NAME Manual $QTC_VERSION"
diff --git a/doc/config/style/qt5-sidebar.html b/doc/config/style/qt5-sidebar.html
deleted file mode 100644
index 0069cb9709..0000000000
--- a/doc/config/style/qt5-sidebar.html
+++ /dev/null
@@ -1,17 +0,0 @@
-<div class="sectionlist normallist">
- <div class="heading">
- <a name="reference"></a>
- <h2 id="reference">Qt Creator Manual</h2>
- </div>
- <div class="indexboxcont indexboxbar">
- <ul>
- <li><a href="creator-getting-started.html">Getting Started</a></li>
- <li><a href="creator-project-managing.html">Managing Projects</a></li>
- <li><a href="creator-design-mode.html">Designing User Interfaces</a></li>
- <li><a href="creator-coding.html">Coding</a></li>
- <li><a href="creator-building-running.html">Building and Running</a></li>
- <li><a href="creator-testing.html">Testing</a></li>
- <li><a href="creator-advanced.html">Advanced Use</a></li>
- <li><a href="creator-help-overview.html">Getting Help</a></li>
- </ul>
- </div>