3 if(NOT SPHINX_EXECUTABLE)
5 message(WARNING "The sphinx-build command is required to build documentation.")
9 if(NOT DEFINED SPHINX_OPTIONS)
13 if(NOT DEFINED SPHINX_THEME)
14 set(SPHINX_THEME sphinx_rtd_theme)
15 set(SPHINX_THEME_OPTIONS "'collapse_navigation':False, 'navigation_depth':2, 'titles_only':False, 'includehidden':False")
18 set(SPHINX_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/source")
20 # configured documentation tools and intermediate build results
21 set(SPHINX_BUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}")
23 # Sphinx cache with pickled ReST documents
24 set(SPHINX_CACHE_DIR "${SPHINX_BUILD_DIR}/_doctrees")
26 # HTML output directory
27 set(SPHINX_HTML_DIR "${SPHINX_BUILD_DIR}/html")
29 # MAN output directory
30 set(SPHINX_MAN_DIR "${SPHINX_BUILD_DIR}/man")
32 configure_file("conf.py.in" "conf.py" @ONLY)
33 add_subdirectory(source)
36 add_custom_target(html
40 -c "${SPHINX_BUILD_DIR}"
41 -d "${SPHINX_CACHE_DIR}"
43 "${SPHINX_SOURCE_DIR}"
45 BYPRODUCTS ${SPHINX_HTML_DIR}
50 add_custom_target(man ALL
53 -c "${SPHINX_BUILD_DIR}"
54 -d "${SPHINX_CACHE_DIR}"
56 "${SPHINX_SOURCE_DIR}"
58 BYPRODUCTS ${SPHINX_MAN_DIR}
63 find_program(PIGZ pigz)
67 find_package(UnixCommands)
71 add_custom_target(man_gz ALL
72 ${GZIP} -kf ${SPHINX_MAN_DIR}/*.{1,3}
78 install(DIRECTORY ${SPHINX_MAN_DIR}/
79 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1
80 FILES_MATCHING PATTERN *.1${MAN_EXT}
82 install(DIRECTORY ${SPHINX_MAN_DIR}/
83 DESTINATION ${CMAKE_INSTALL_MANDIR}/man3
84 FILES_MATCHING PATTERN *.3${MAN_EXT}