SphinxDoc.cmake 1.7 KB

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