Blame view

3rdparty/boost_1_81_0/libs/hof/cmake/SphinxDoc.cmake 1.69 KB
73ef4ff3   Hu Chunming   提交三方库
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
  include(CMakeParseArguments)
  include(ProcessorCount)
  
  find_program(SPHINX_EXECUTABLE NAMES sphinx-build
      HINTS
      $ENV{SPHINX_DIR}
      PATH_SUFFIXES bin
      DOC "Sphinx documentation generator"
  )
  
  mark_as_advanced(SPHINX_EXECUTABLE)
  
  function(clean_doc_output DIR)
      set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_MAKE_CLEAN_FILES ${DIR})
  endfunction()
  
  set(BINARY_BUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}/sphinx/_build")
   
  # Sphinx cache with pickled ReST documents
  set(SPHINX_CACHE_DIR "${CMAKE_CURRENT_BINARY_DIR}/sphinx/_doctrees")
   
  # HTML output directory
  set(SPHINX_DEFAULT_HTML_DIR "${CMAKE_CURRENT_BINARY_DIR}/sphinx/html")
  function(add_sphinx_doc SRC_DIR)
      set(options)
      set(oneValueArgs HTML_DIR)
      set(multiValueArgs VARS TEMPLATE_VARS)
  
      cmake_parse_arguments(PARSE "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
      ProcessorCount(N)
  
      set(ADDITIONAL_ARGS)
      foreach(VAR ${PARSE_VARS})
          list(APPEND ADDITIONAL_ARGS "-D ${VAR}")
      endforeach()
      foreach(VAR ${PARSE_TEMPLATE_VARS})
          list(APPEND ADDITIONAL_ARGS "-A ${VAR}")
      endforeach()
  
      if(PARSE_HTML_DIR)
          set(SPHINX_HTML_DIR ${PARSE_HTML_DIR} CACHE PATH "Path to html output")
      else()
          set(SPHINX_HTML_DIR ${SPHINX_DEFAULT_HTML_DIR} CACHE PATH "Path to html output")
      endif()
  
      clean_doc_output(${SPHINX_HTML_DIR})
      clean_doc_output(${SPHINX_CACHE_DIR})
      clean_doc_output(${BINARY_BUILD_DIR})
  
      add_custom_target(doc
          ${SPHINX_EXECUTABLE}
          -j ${N}
          -n
          -b html
          -d "${SPHINX_CACHE_DIR}"
          ${ADDITIONAL_ARGS}
          "${SRC_DIR}"
          "${SPHINX_HTML_DIR}"
      COMMENT "Building HTML documentation with Sphinx")
  endfunction()