Drop documentation generation during build
Drop the 'documentation' build target. We will no longer use the executables to generate their own documentation. New infrastructure will be introduced later to generate documentation.
This commit is contained in:
Brad King
parent
09be0bb049
commit
678aaad133
|
|
@ -10,123 +10,3 @@
|
|||
# See the License for more information.
|
||||
#=============================================================================
|
||||
subdirs(Doxygen KWStyle)
|
||||
|
||||
make_directory(${CMake_BINARY_DIR}/Docs)
|
||||
|
||||
# Add a documentation target.
|
||||
set(DOC_FILES "")
|
||||
|
||||
set(MAN_FILES
|
||||
${CMake_BINARY_DIR}/Docs/cmake.1
|
||||
${CMake_BINARY_DIR}/Docs/cmakecommands.1
|
||||
${CMake_BINARY_DIR}/Docs/cmakecompat.1
|
||||
${CMake_BINARY_DIR}/Docs/cmakeprops.1
|
||||
${CMake_BINARY_DIR}/Docs/cmakepolicies.1
|
||||
${CMake_BINARY_DIR}/Docs/cmakevars.1
|
||||
${CMake_BINARY_DIR}/Docs/cmakemodules.1
|
||||
)
|
||||
set(TEXT_FILES
|
||||
${CMake_BINARY_DIR}/Docs/cmake.txt
|
||||
${CMake_BINARY_DIR}/Docs/cmake-policies.txt
|
||||
${CMake_BINARY_DIR}/Docs/cmake-properties.txt
|
||||
${CMake_BINARY_DIR}/Docs/cmake-variables.txt
|
||||
${CMake_BINARY_DIR}/Docs/cmake-modules.txt
|
||||
${CMake_BINARY_DIR}/Docs/cmake-commands.txt
|
||||
${CMake_BINARY_DIR}/Docs/cmake-compatcommands.txt
|
||||
)
|
||||
set(HTML_FILES
|
||||
${CMake_BINARY_DIR}/Docs/cmake.html
|
||||
${CMake_BINARY_DIR}/Docs/cmake-policies.html
|
||||
${CMake_BINARY_DIR}/Docs/cmake-properties.html
|
||||
${CMake_BINARY_DIR}/Docs/cmake-variables.html
|
||||
${CMake_BINARY_DIR}/Docs/cmake-modules.html
|
||||
${CMake_BINARY_DIR}/Docs/cmake-commands.html
|
||||
${CMake_BINARY_DIR}/Docs/cmake-compatcommands.html
|
||||
)
|
||||
set(DOCBOOK_FILES
|
||||
${CMake_BINARY_DIR}/Docs/cmake.docbook
|
||||
)
|
||||
|
||||
macro(ADD_DOCS target dependency)
|
||||
# only generate the documentation if the target is actually built
|
||||
if(${target})
|
||||
add_custom_command(
|
||||
OUTPUT ${CMake_BINARY_DIR}/Docs/${target}.txt
|
||||
${${target}-PATH} # Possibly set PATH, see below.
|
||||
COMMAND $<TARGET_FILE:${target}>
|
||||
ARGS --help-full ${CMake_BINARY_DIR}/Docs/${target}.txt
|
||||
--help-full ${CMake_BINARY_DIR}/Docs/${target}.html
|
||||
--help-full ${CMake_BINARY_DIR}/Docs/${target}.1
|
||||
--help-full ${CMake_BINARY_DIR}/Docs/${target}.docbook
|
||||
DEPENDS ${target}
|
||||
MAIN_DEPENDENCY ${dependency}
|
||||
)
|
||||
set(DOC_FILES ${DOC_FILES} ${CMake_BINARY_DIR}/Docs/${target}.txt)
|
||||
list(APPEND MAN_FILES ${CMake_BINARY_DIR}/Docs/${target}.1)
|
||||
list(APPEND TEXT_FILES ${CMake_BINARY_DIR}/Docs/${target}.txt)
|
||||
list(APPEND HTML_FILES ${CMake_BINARY_DIR}/Docs/${target}.html)
|
||||
list(APPEND DOCBOOK_FILES ${CMake_BINARY_DIR}/Docs/${target}.docbook)
|
||||
endif()
|
||||
endmacro()
|
||||
|
||||
# Help cmake-gui find the Qt DLLs on Windows.
|
||||
if(TARGET cmake-gui)
|
||||
get_property(Qt_BIN_DIR TARGET cmake-gui PROPERTY Qt_BIN_DIR)
|
||||
set(WIN_SHELL_GENS "Visual Studio|NMake|MinGW|Watcom|Borland")
|
||||
if(Qt_BIN_DIR AND "${CMAKE_GENERATOR}" MATCHES "${WIN_SHELL_GENS}"
|
||||
AND NOT CMAKE_NO_AUTO_QT_ENV)
|
||||
# Tell the macro to set the path before running cmake-gui.
|
||||
string(REPLACE ";" "\\;" _PATH "PATH=${Qt_BIN_DIR};%PATH%")
|
||||
set(cmake-gui-PATH COMMAND set "${_PATH}")
|
||||
endif()
|
||||
endif()
|
||||
|
||||
# add the docs for the executables
|
||||
ADD_DOCS(ctest ${CMake_SOURCE_DIR}/Utilities/Doxygen/authors.txt)
|
||||
ADD_DOCS(cpack ${CMake_SOURCE_DIR}/Utilities/Doxygen/authors.txt)
|
||||
ADD_DOCS(ccmake ${CMake_SOURCE_DIR}/Utilities/Doxygen/authors.txt)
|
||||
ADD_DOCS(CMakeSetup ${CMake_SOURCE_DIR}/Utilities/Doxygen/doxyfile.in)
|
||||
ADD_DOCS(cmake-gui ${CMake_SOURCE_DIR}/Utilities/Doxygen/doxyfile.in)
|
||||
|
||||
# add the documentation for cmake itself
|
||||
|
||||
add_custom_command(
|
||||
OUTPUT ${CMake_BINARY_DIR}/Docs/cmake.txt
|
||||
COMMAND $<TARGET_FILE:cmake>
|
||||
ARGS --copyright ${CMake_BINARY_DIR}/Docs/Copyright.txt
|
||||
--help-full ${CMake_BINARY_DIR}/Docs/cmake.txt
|
||||
--help-full ${CMake_BINARY_DIR}/Docs/cmake.html
|
||||
--help-full ${CMake_BINARY_DIR}/Docs/cmake.1
|
||||
--help-full ${CMake_BINARY_DIR}/Docs/cmake.docbook
|
||||
--help-policies ${CMake_BINARY_DIR}/Docs/cmake-policies.txt
|
||||
--help-policies ${CMake_BINARY_DIR}/Docs/cmake-policies.html
|
||||
--help-policies ${CMake_BINARY_DIR}/Docs/cmakepolicies.1
|
||||
--help-properties ${CMake_BINARY_DIR}/Docs/cmake-properties.txt
|
||||
--help-properties ${CMake_BINARY_DIR}/Docs/cmake-properties.html
|
||||
--help-properties ${CMake_BINARY_DIR}/Docs/cmakeprops.1
|
||||
--help-variables ${CMake_BINARY_DIR}/Docs/cmake-variables.txt
|
||||
--help-variables ${CMake_BINARY_DIR}/Docs/cmake-variables.html
|
||||
--help-variables ${CMake_BINARY_DIR}/Docs/cmakevars.1
|
||||
--help-modules ${CMake_BINARY_DIR}/Docs/cmake-modules.txt
|
||||
--help-modules ${CMake_BINARY_DIR}/Docs/cmake-modules.html
|
||||
--help-modules ${CMake_BINARY_DIR}/Docs/cmakemodules.1
|
||||
--help-commands ${CMake_BINARY_DIR}/Docs/cmake-commands.txt
|
||||
--help-commands ${CMake_BINARY_DIR}/Docs/cmake-commands.html
|
||||
--help-commands ${CMake_BINARY_DIR}/Docs/cmakecommands.1
|
||||
--help-compatcommands ${CMake_BINARY_DIR}/Docs/cmake-compatcommands.txt
|
||||
--help-compatcommands ${CMake_BINARY_DIR}/Docs/cmake-compatcommands.html
|
||||
--help-compatcommands ${CMake_BINARY_DIR}/Docs/cmakecompat.1
|
||||
DEPENDS cmake
|
||||
MAIN_DEPENDENCY ${CMake_SOURCE_DIR}/Utilities/Doxygen/authors.txt
|
||||
)
|
||||
|
||||
install(FILES ${MAN_FILES} DESTINATION ${CMAKE_MAN_DIR}/man1)
|
||||
install(FILES
|
||||
${TEXT_FILES}
|
||||
${HTML_FILES}
|
||||
${DOCBOOK_FILES}
|
||||
DESTINATION ${CMAKE_DOC_DIR}
|
||||
)
|
||||
|
||||
# Drive documentation generation.
|
||||
add_custom_target(documentation ALL DEPENDS ${DOC_FILES} ${CMake_BINARY_DIR}/Docs/cmake.txt )
|
||||
|
|
|
|||
Loading…
Reference in New Issue