Warning, /acts/docs/CMakeLists.txt is written in an unsupported language. File is not indexed.
0001 # to be compatible with readthedocs.org, the documentation build is always
0002 # in-source; as opposed to the configurable out-of-source build directory for
0003 # the code. when running running on readthedocs.org, the build is fully driven
0004 # by Sphinx, including running Doxygen.
0005 #
0006 # this CMake-based build is only intended for local development.
0007
0008 set(sphinx_build ${CMAKE_CURRENT_SOURCE_DIR}/_build)
0009 set(sphinx_doctrees ${CMAKE_CURRENT_SOURCE_DIR}/_build/doctrees)
0010 set(sphinx_html ${CMAKE_CURRENT_SOURCE_DIR}/_build/html)
0011
0012 set(sphinx_command)
0013 list(APPEND sphinx_command "-b;html")
0014 list(APPEND sphinx_command "-d;${sphinx_doctrees}")
0015 list(APPEND sphinx_command "-j;auto")
0016 list(APPEND sphinx_command "-W;--keep-going")
0017 list(APPEND sphinx_command "-t;run_doxygen;-t;lazy_autodoc")
0018
0019 if(DEFINED ENV{CI})
0020 list(APPEND sphinx_command "-b;linkcheck")
0021 endif()
0022
0023 list(APPEND sphinx_command "${CMAKE_CURRENT_SOURCE_DIR}")
0024 list(APPEND sphinx_command "${sphinx_html}")
0025
0026 message(${sphinx_command})
0027
0028 # standard target to build the documentation without automatic API generation
0029 add_custom_target(
0030 docs
0031 COMMAND ${Sphinx_EXECUTABLE} ${sphinx_command}
0032 WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
0033 COMMENT "Build documentation"
0034 )
0035
0036 install(
0037 DIRECTORY ${sphinx_html}/
0038 DESTINATION ${CMAKE_INSTALL_DOCDIR}/Acts
0039 OPTIONAL
0040 )
