github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2024-12-03 08:23:51 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
66e238fad0
fish-shell/cmake/Docs.cmake

82 lines
2.7 KiB
CMake
Raw Normal View History

Initial sphinx file import
2018-12-16 08:23:36 +08:00
FIND_PROGRAM(SPHINX_EXECUTABLE NAMES sphinx-build
HINTS
$ENV{SPHINX_DIR}
PATH_SUFFIXES bin
DOC "Sphinx documentation generator")
[cmake] make building documentation optional Add a BUILD_DOCS option which is contingent on Doxygen being present, and only build the documentation if this is enabled.
2018-01-14 21:16:11 +08:00
INCLUDE(FeatureSummary)
Initial sphinx file import
2018-12-16 08:23:36 +08:00
SET(SPHINX_SRC_DIR "${CMAKE_CURRENT_SOURCE_DIR}/sphinx_doc_src")
Install sphinx files Sphinx put the files into sphinx-root, which wasn't being installed. Instead, use user_doc again, which we already used before. Belongs to #5696.
2019-02-26 04:05:02 +08:00
SET(SPHINX_ROOT_DIR "${CMAKE_CURRENT_BINARY_DIR}/user_doc")
Initial sphinx file import
2018-12-16 08:23:36 +08:00
SET(SPHINX_BUILD_DIR "${SPHINX_ROOT_DIR}/build")
SET(SPHINX_CACHE_DIR "${SPHINX_ROOT_DIR}/doctrees")
SET(SPHINX_HTML_DIR "${SPHINX_ROOT_DIR}/html")
SET(SPHINX_MANPAGE_DIR "${SPHINX_ROOT_DIR}/man")
Teach CMake to tell Sphinx where fish_indent is
2019-03-15 04:50:35 +08:00
# sphinx-docs uses fish_indent for highlighting.
# Prepend the output dir of fish_indent to PATH.
Initial sphinx file import
2018-12-16 08:23:36 +08:00
ADD_CUSTOM_TARGET(sphinx-docs
Teach CMake to tell Sphinx where fish_indent is
2019-03-15 04:50:35 +08:00
env PATH="$<TARGET_FILE_DIR:fish_indent>:$$PATH"
${SPHINX_EXECUTABLE}
Initial sphinx file import
2018-12-16 08:23:36 +08:00
-q -b html
-c "${SPHINX_SRC_DIR}"
-d "${SPHINX_CACHE_DIR}"
"${SPHINX_SRC_DIR}"
"${SPHINX_HTML_DIR}"
Teach CMake to tell Sphinx where fish_indent is
2019-03-15 04:50:35 +08:00
DEPENDS sphinx_doc_src/fish_indent_lexer.py fish_indent
Initial sphinx file import
2018-12-16 08:23:36 +08:00
COMMENT "Building HTML documentation with Sphinx")
ADD_CUSTOM_TARGET(sphinx-manpages
${SPHINX_EXECUTABLE}
-q -b man
-c "${SPHINX_SRC_DIR}"
-d "${SPHINX_CACHE_DIR}"
"${SPHINX_SRC_DIR}"
Fix manpage directory This installed files in man/ directly, instead of in man/man1/, so they weren't installed. See #5696.
2019-02-26 04:12:08 +08:00
# TODO: This only works if we only have section 1 manpages.
"${SPHINX_MANPAGE_DIR}/man1"
Initial sphinx file import
2018-12-16 08:23:36 +08:00
COMMENT "Building man pages with Sphinx")
CMake BUILD_DOCS option to look for sphinx instead of Doxygen
2019-02-25 10:44:29 +08:00
IF(SPHINX_EXECUTABLE)
OPTION(BUILD_DOCS "build documentation (requires Sphinx)" ON)
ELSE(SPHINX_EXECUTABLE)
OPTION(BUILD_DOCS "build documentation (requires Sphinx)" OFF)
ENDIF(SPHINX_EXECUTABLE)
[cmake] make building documentation optional Add a BUILD_DOCS option which is contingent on Doxygen being present, and only build the documentation if this is enabled.
2018-01-14 21:16:11 +08:00
CMake BUILD_DOCS option to look for sphinx instead of Doxygen
2019-02-25 10:44:29 +08:00
IF(BUILD_DOCS AND NOT SPHINX_EXECUTABLE)
MESSAGE(FATAL_ERROR "build documentation selected, but sphinx-build could not be found")
[cmake] copy shipped documentation files if they exist Enables documentation in tarballs to be installed, even if Doxygen isn't present.
2018-02-01 22:46:15 +08:00
ENDIF()
IF(IS_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/user_doc/html
cmake: fix prebuilt documentation detection and installation
2019-03-04 22:06:07 +08:00
AND IS_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/user_doc/man)
[cmake] copy shipped documentation files if they exist Enables documentation in tarballs to be installed, even if Doxygen isn't present.
2018-02-01 22:46:15 +08:00
SET(HAVE_PREBUILT_DOCS TRUE)
ELSE()
SET(HAVE_PREBUILT_DOCS FALSE)
ENDIF()
IF(BUILD_DOCS OR HAVE_PREBUILT_DOCS)
SET(INSTALL_DOCS ON)
ELSE()
SET(INSTALL_DOCS OFF)
ENDIF()
ADD_FEATURE_INFO(Documentation INSTALL_DOCS "user manual and documentation")
[cmake] make building documentation optional Add a BUILD_DOCS option which is contingent on Doxygen being present, and only build the documentation if this is enabled.
2018-01-14 21:16:11 +08:00
IF(BUILD_DOCS)
cmake: fix prebuilt documentation detection and installation
2019-03-04 22:06:07 +08:00
CONFIGURE_FILE("${SPHINX_SRC_DIR}/conf.py" "${SPHINX_BUILD_DIR}/conf.py" @ONLY)
[cmake] add doc target to ALL Closes #4809.
2018-03-14 21:44:17 +08:00
ADD_CUSTOM_TARGET(doc ALL
Remove last vestiges of Doxygen from Docs.cmake
2019-02-25 11:02:39 +08:00
DEPENDS sphinx-docs sphinx-manpages)
[cmake] make building documentation optional Add a BUILD_DOCS option which is contingent on Doxygen being present, and only build the documentation if this is enabled.
2018-01-14 21:16:11 +08:00
# Group docs targets into a DocsTargets folder
Remove last vestiges of Doxygen from Docs.cmake
2019-02-25 11:02:39 +08:00
SET_PROPERTY(TARGET doc sphinx-docs sphinx-manpages
[cmake] make building documentation optional Add a BUILD_DOCS option which is contingent on Doxygen being present, and only build the documentation if this is enabled.
2018-01-14 21:16:11 +08:00
PROPERTY FOLDER cmake/DocTargets)
Remove last vestiges of Doxygen from Docs.cmake
2019-02-25 11:02:39 +08:00
[cmake] support prebuilt documentation in out-of-tree builds
2018-03-24 22:34:30 +08:00
ELSEIF(HAVE_PREBUILT_DOCS)
IF(NOT CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_CURRENT_BINARY_DIR)
# Out of tree build - link the prebuilt documentation to the build tree
ADD_CUSTOM_TARGET(link_doc ALL)
ADD_CUSTOM_COMMAND(TARGET link_doc
COMMAND ${CMAKE_COMMAND} -E create_symlink ${CMAKE_CURRENT_SOURCE_DIR}/user_doc ${CMAKE_CURRENT_BINARY_DIR}/user_doc
POST_BUILD)
ENDIF()
[cmake] make building documentation optional Add a BUILD_DOCS option which is contingent on Doxygen being present, and only build the documentation if this is enabled.
2018-01-14 21:16:11 +08:00
ENDIF(BUILD_DOCS)
Reference in New Issue Copy Permalink