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>
6
.gitignore
vendored
@@ -122,9 +122,9 @@ compile_commands.json
|
|||||||
/dist/gdb/source/
|
/dist/gdb/source/
|
||||||
/dist/gdb/staging/
|
/dist/gdb/staging/
|
||||||
/doc/qbs/
|
/doc/qbs/
|
||||||
/doc/qtcreator/
|
/doc/html/qtcreator/
|
||||||
/doc/qtcreator-dev/
|
/doc/html/qtcreator-dev/
|
||||||
/doc/pluginhowto/html/
|
/doc/html/qtdesignstudio/
|
||||||
/lib/
|
/lib/
|
||||||
/lib64/
|
/lib64/
|
||||||
/libexec/
|
/libexec/
|
||||||
|
@@ -202,7 +202,7 @@ if (WITH_ONLINE_DOCS OR WITH_DOCS)
|
|||||||
set(_qch_params "QCH;QCH_DIR;${PROJECT_BINARY_DIR}/${IDE_DOC_PATH}")
|
set(_qch_params "QCH;QCH_DIR;${PROJECT_BINARY_DIR}/${IDE_DOC_PATH}")
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
set(_qdoc_params HTML_DIR "${PROJECT_BINARY_DIR}/doc")
|
set(_qdoc_params HTML_DIR "${PROJECT_BINARY_DIR}/doc/html")
|
||||||
list(APPEND _qdoc_params INDEXES "${QT_INSTALL_DOCS}" "${PROJECT_BINARY_DIR}/doc")
|
list(APPEND _qdoc_params INDEXES "${QT_INSTALL_DOCS}" "${PROJECT_BINARY_DIR}/doc")
|
||||||
list(APPEND _qdoc_params INSTALL_DIR "${IDE_DOC_PATH}")
|
list(APPEND _qdoc_params INSTALL_DIR "${IDE_DOC_PATH}")
|
||||||
|
|
||||||
@@ -229,15 +229,15 @@ if (WITH_ONLINE_DOCS OR WITH_DOCS)
|
|||||||
QT_INSTALL_DOCS QDOC_INDEX_DIR)
|
QT_INSTALL_DOCS QDOC_INDEX_DIR)
|
||||||
|
|
||||||
if (WITH_DOCS)
|
if (WITH_DOCS)
|
||||||
qdoc_build_qdocconf_file("qtcreator.qdocconf" ${_qch_params} ${_qdoc_params})
|
qdoc_build_qdocconf_file("qtcreator/qtcreator.qdocconf" ${_qch_params} ${_qdoc_params})
|
||||||
if (BUILD_DEVELOPER_DOCS)
|
if (BUILD_DEVELOPER_DOCS)
|
||||||
qdoc_build_qdocconf_file("api/qtcreator-dev.qdocconf" ${_qch_params} ${_qdoc_params})
|
qdoc_build_qdocconf_file("qtcreatordev/qtcreator-dev.qdocconf" ${_qch_params} ${_qdoc_params})
|
||||||
endif()
|
endif()
|
||||||
endif()
|
endif()
|
||||||
if(WITH_ONLINE_DOCS)
|
if(WITH_ONLINE_DOCS)
|
||||||
qdoc_build_qdocconf_file("qtcreator-online.qdocconf" ${_qdoc_params})
|
qdoc_build_qdocconf_file("qtcreator/qtcreator-online.qdocconf" ${_qdoc_params})
|
||||||
if (BUILD_DEVELOPER_DOCS)
|
if (BUILD_DEVELOPER_DOCS)
|
||||||
qdoc_build_qdocconf_file("api/qtcreator-dev-online.qdocconf" ${_qdoc_params})
|
qdoc_build_qdocconf_file("qtcreatordev/qtcreator-dev-online.qdocconf" ${_qdoc_params})
|
||||||
endif()
|
endif()
|
||||||
endif()
|
endif()
|
||||||
endif()
|
endif()
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
build_online_docs: \
|
build_online_docs: \
|
||||||
DOC_FILES += $$PWD/qtcreator-online.qdocconf $$PWD/api/qtcreator-dev-online.qdocconf
|
DOC_FILES += $$PWD/qtcreator/qtcreator-online.qdocconf $$PWD/qtcreatordev/qtcreator-dev-online.qdocconf
|
||||||
else: \
|
else: \
|
||||||
DOC_FILES += $$PWD/qtcreator.qdocconf $$PWD/api/qtcreator-dev.qdocconf
|
DOC_FILES += $$PWD/qtcreator/qtcreator.qdocconf $$PWD/qtcreatordev/qtcreator-dev.qdocconf
|
||||||
|
|
||||||
include(../docs.pri)
|
include(../docs.pri)
|
||||||
|
|
||||||
|
@@ -30,7 +30,7 @@ QT_TOOL_ENV =
|
|||||||
|
|
||||||
!build_online_docs: qtPrepareTool(QHELPGENERATOR, qhelpgenerator)
|
!build_online_docs: qtPrepareTool(QHELPGENERATOR, qhelpgenerator)
|
||||||
|
|
||||||
DOCS_BASE_OUTDIR = $$OUT_PWD/doc
|
DOCS_BASE_OUTDIR = $$OUT_PWD/doc/html
|
||||||
DOC_INDEXES += -indexdir $$shell_quote($$[QT_INSTALL_DOCS])
|
DOC_INDEXES += -indexdir $$shell_quote($$[QT_INSTALL_DOCS])
|
||||||
for (index_path, DOC_INDEX_PATHS): \
|
for (index_path, DOC_INDEX_PATHS): \
|
||||||
DOC_INDEXES += -indexdir $$shell_quote($$index_path)
|
DOC_INDEXES += -indexdir $$shell_quote($$index_path)
|
||||||
|
@@ -5,32 +5,31 @@ url = http://doc.qt.io/$IDE_ID
|
|||||||
headerdirs =
|
headerdirs =
|
||||||
sourcedirs = ../src
|
sourcedirs = ../src
|
||||||
imagedirs = ../images \
|
imagedirs = ../images \
|
||||||
../templates/images \
|
../../../src/libs/qmleditorwidgets/images \
|
||||||
../../src/libs/qmleditorwidgets/images \
|
../../../src/libs/utils/images \
|
||||||
../../src/libs/utils/images \
|
../../../src/plugins/android/images \
|
||||||
../../src/plugins/android/images \
|
../../../src/plugins/autotest/images \
|
||||||
../../src/plugins/autotest/images \
|
../../../src/plugins/classview/images \
|
||||||
../../src/plugins/classview/images \
|
../../../src/plugins/coreplugin/images \
|
||||||
../../src/plugins/coreplugin/images \
|
../../../src/plugins/debugger/images \
|
||||||
../../src/plugins/debugger/images \
|
../../../src/plugins/diffeditor/images \
|
||||||
../../src/plugins/diffeditor/images \
|
../../../src/plugins/help/images \
|
||||||
../../src/plugins/help/images \
|
../../../src/plugins/projectexplorer/images \
|
||||||
../../src/plugins/projectexplorer/images \
|
../../../src/plugins/qmldesigner/components/componentcore/images \
|
||||||
../../src/plugins/qmldesigner/components/componentcore/images \
|
../../../src/plugins/qmldesigner/components/formeditor \
|
||||||
../../src/plugins/qmldesigner/components/formeditor \
|
../../../src/plugins/qmldesigner/components/navigator \
|
||||||
../../src/plugins/qmldesigner/components/navigator \
|
../../../src/plugins/qmldesigner/components/timelineeditor/images \
|
||||||
../../src/plugins/qmldesigner/components/timelineeditor/images \
|
../../../src/plugins/qmldesigner/qmlpreviewplugin/images \
|
||||||
../../src/plugins/qmldesigner/qmlpreviewplugin/images \
|
../../../src/plugins/scxmleditor/common/images \
|
||||||
../../src/plugins/scxmleditor/common/images \
|
../../../src/plugins/texteditor/images \
|
||||||
../../src/plugins/texteditor/images \
|
../../../src/plugins/valgrind/images \
|
||||||
../../src/plugins/valgrind/images \
|
../../../src/plugins/welcome/images
|
||||||
../../src/plugins/welcome/images
|
|
||||||
|
|
||||||
exampledirs = ../examples
|
exampledirs = ../examples
|
||||||
examples.fileextensions += *.qml *.svg
|
examples.fileextensions += *.qml *.svg
|
||||||
|
|
||||||
HTML.extraimages = images/commercial.png
|
HTML.extraimages = ../../config/images/commercial.png
|
||||||
qhp.QtCreator.extraFiles = images/commercial.png
|
qhp.QtCreator.extraFiles = ../../config/images/commercial.png
|
||||||
|
|
||||||
depends += qtwidgets \
|
depends += qtwidgets \
|
||||||
qtcmake \
|
qtcmake \
|
||||||
@@ -52,9 +51,9 @@ depends += qtwidgets \
|
|||||||
qtuitools \
|
qtuitools \
|
||||||
qtxml
|
qtxml
|
||||||
|
|
||||||
include(macros.qdocconf)
|
include(../../config/macros.qdocconf)
|
||||||
include(qt-cpp-ignore.qdocconf)
|
include(../../config/qt-cpp-ignore.qdocconf)
|
||||||
include(qt-defines.qdocconf)
|
include(../../config/qt-defines.qdocconf)
|
||||||
|
|
||||||
defines += qtcreator
|
defines += qtcreator
|
||||||
|
|
Before Width: | Height: | Size: 399 B After Width: | Height: | Size: 399 B |
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 48 KiB |
Before Width: | Height: | Size: 1.5 KiB After Width: | Height: | Size: 1.5 KiB |
Before Width: | Height: | Size: 98 B After Width: | Height: | Size: 98 B |
Before Width: | Height: | Size: 108 B After Width: | Height: | Size: 108 B |
Before Width: | Height: | Size: 95 B After Width: | Height: | Size: 95 B |
Before Width: | Height: | Size: 97 B After Width: | Height: | Size: 97 B |
Before Width: | Height: | Size: 97 B After Width: | Height: | Size: 97 B |
Before Width: | Height: | Size: 99 B After Width: | Height: | Size: 99 B |
Before Width: | Height: | Size: 96 B After Width: | Height: | Size: 96 B |
Before Width: | Height: | Size: 9.7 KiB After Width: | Height: | Size: 9.7 KiB |
Before Width: | Height: | Size: 31 KiB After Width: | Height: | Size: 31 KiB |
Before Width: | Height: | Size: 573 B After Width: | Height: | Size: 573 B |
Before Width: | Height: | Size: 387 B After Width: | Height: | Size: 387 B |
Before Width: | Height: | Size: 359 B After Width: | Height: | Size: 359 B |
Before Width: | Height: | Size: 478 B After Width: | Height: | Size: 478 B |
Before Width: | Height: | Size: 583 B After Width: | Height: | Size: 583 B |
Before Width: | Height: | Size: 656 B After Width: | Height: | Size: 656 B |
Before Width: | Height: | Size: 647 B After Width: | Height: | Size: 647 B |
Before Width: | Height: | Size: 341 B After Width: | Height: | Size: 341 B |
Before Width: | Height: | Size: 405 B After Width: | Height: | Size: 405 B |
Before Width: | Height: | Size: 377 B After Width: | Height: | Size: 377 B |
Before Width: | Height: | Size: 381 B After Width: | Height: | Size: 381 B |
Before Width: | Height: | Size: 393 B After Width: | Height: | Size: 393 B |
Before Width: | Height: | Size: 498 B After Width: | Height: | Size: 498 B |
Before Width: | Height: | Size: 468 B After Width: | Height: | Size: 468 B |
Before Width: | Height: | Size: 452 B After Width: | Height: | Size: 452 B |
Before Width: | Height: | Size: 231 B After Width: | Height: | Size: 231 B |
Before Width: | Height: | Size: 530 B After Width: | Height: | Size: 530 B |
Before Width: | Height: | Size: 632 B After Width: | Height: | Size: 632 B |
Before Width: | Height: | Size: 619 B After Width: | Height: | Size: 619 B |
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 23 KiB |
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 22 KiB |
Before Width: | Height: | Size: 9.9 KiB After Width: | Height: | Size: 9.9 KiB |
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 35 KiB |
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
Before Width: | Height: | Size: 4.3 KiB After Width: | Height: | Size: 4.3 KiB |
Before Width: | Height: | Size: 4.2 KiB After Width: | Height: | Size: 4.2 KiB |
Before Width: | Height: | Size: 5.9 KiB After Width: | Height: | Size: 5.9 KiB |
Before Width: | Height: | Size: 2.7 KiB After Width: | Height: | Size: 2.7 KiB |
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 56 KiB |
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
Before Width: | Height: | Size: 5.4 KiB After Width: | Height: | Size: 5.4 KiB |
Before Width: | Height: | Size: 136 KiB After Width: | Height: | Size: 136 KiB |
Before Width: | Height: | Size: 7.4 KiB After Width: | Height: | Size: 7.4 KiB |
Before Width: | Height: | Size: 7.8 KiB After Width: | Height: | Size: 7.8 KiB |
Before Width: | Height: | Size: 5.4 KiB After Width: | Height: | Size: 5.4 KiB |
Before Width: | Height: | Size: 4.0 KiB After Width: | Height: | Size: 4.0 KiB |
Before Width: | Height: | Size: 4.2 KiB After Width: | Height: | Size: 4.2 KiB |
Before Width: | Height: | Size: 4.7 KiB After Width: | Height: | Size: 4.7 KiB |
Before Width: | Height: | Size: 7.5 KiB After Width: | Height: | Size: 7.5 KiB |
Before Width: | Height: | Size: 6.6 KiB After Width: | Height: | Size: 6.6 KiB |
Before Width: | Height: | Size: 5.8 KiB After Width: | Height: | Size: 5.8 KiB |
Before Width: | Height: | Size: 6.5 KiB After Width: | Height: | Size: 6.5 KiB |
Before Width: | Height: | Size: 417 B After Width: | Height: | Size: 417 B |
Before Width: | Height: | Size: 273 B After Width: | Height: | Size: 273 B |
Before Width: | Height: | Size: 119 B After Width: | Height: | Size: 119 B |
Before Width: | Height: | Size: 367 B After Width: | Height: | Size: 367 B |
Before Width: | Height: | Size: 289 B After Width: | Height: | Size: 289 B |
Before Width: | Height: | Size: 434 B After Width: | Height: | Size: 434 B |
Before Width: | Height: | Size: 1.1 KiB After Width: | Height: | Size: 1.1 KiB |
Before Width: | Height: | Size: 1.3 KiB After Width: | Height: | Size: 1.3 KiB |
Before Width: | Height: | Size: 1.3 KiB After Width: | Height: | Size: 1.3 KiB |