mirror of https://github.com/triqs/dft_tools
82 lines
3.4 KiB
CMake
82 lines
3.4 KiB
CMake
# Generate the sphinx config file
|
|
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/conf.py.in ${CMAKE_CURRENT_BINARY_DIR}/conf.py @ONLY)
|
|
|
|
# -----------------------------------------------------------------------------
|
|
# Create an optional target that allows us to regenerate the C++ doc with c++2rst
|
|
# -----------------------------------------------------------------------------
|
|
add_custom_target(${PROJECT_NAME}_docs_cpp2rst)
|
|
include(${PROJECT_SOURCE_DIR}/share/cmake/extract_flags.cmake)
|
|
extract_flags(${PROJECT_NAME}_c BUILD_INTERFACE)
|
|
separate_arguments(${PROJECT_NAME}_c_CXXFLAGS)
|
|
macro(generate_docs header_file)
|
|
add_custom_command(
|
|
TARGET ${PROJECT_NAME}_docs_cpp2rst
|
|
COMMAND rm -rf ${CMAKE_CURRENT_SOURCE_DIR}/cpp2rst_generated
|
|
COMMAND
|
|
PYTHONPATH=${CPP2PY_BINARY_DIR}:$ENV{PYTHONPATH}
|
|
PATH=${CPP2PY_BINARY_DIR}/bin:${CPP2PY_ROOT}/bin:$ENV{PATH}
|
|
c++2rst
|
|
${header_file}
|
|
-N ${PROJECT_NAME}
|
|
--output_directory ${CMAKE_CURRENT_SOURCE_DIR}/cpp2rst_generated
|
|
-I${PROJECT_SOURCE_DIR}/c++
|
|
--cxxflags="${${PROJECT_NAME}_c_CXXFLAGS}"
|
|
)
|
|
endmacro(generate_docs)
|
|
|
|
generate_docs(${PROJECT_SOURCE_DIR}/c++/${PROJECT_NAME}/${PROJECT_NAME}.hpp)
|
|
|
|
# --------------------------------------------------------
|
|
# Build & Run the C++ doc examples and capture the output
|
|
# --------------------------------------------------------
|
|
|
|
add_custom_target(${PROJECT_NAME}_docs_example_output)
|
|
file(GLOB_RECURSE ExampleList RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.cpp)
|
|
foreach(example ${ExampleList})
|
|
get_filename_component(f ${example} NAME_WE)
|
|
get_filename_component(d ${example} DIRECTORY)
|
|
add_executable(${PROJECT_NAME}_doc_${f} EXCLUDE_FROM_ALL ${example})
|
|
set_property(TARGET ${PROJECT_NAME}_doc_${f} PROPERTY RUNTIME_OUTPUT_DIRECTORY ${d})
|
|
target_link_libraries(${PROJECT_NAME}_doc_${f} triqs)
|
|
add_custom_command(TARGET ${PROJECT_NAME}_doc_${f}
|
|
COMMAND ${PROJECT_NAME}_doc_${f} > ${CMAKE_CURRENT_SOURCE_DIR}/${d}/${f}.output 2>/dev/null
|
|
WORKING_DIRECTORY ${d}
|
|
)
|
|
add_dependencies(${PROJECT_NAME}_docs_example_output ${PROJECT_NAME}_doc_${f})
|
|
endforeach()
|
|
|
|
# ---------------------------------
|
|
# Top Sphinx target
|
|
# ---------------------------------
|
|
if(NOT DEFINED SPHINXBUILD_EXECUTABLE)
|
|
find_package(Sphinx)
|
|
endif()
|
|
|
|
# Sphinx has internal caching, always run it
|
|
add_custom_target(${PROJECT_NAME}_docs_sphinx ALL)
|
|
add_custom_command(
|
|
TARGET ${PROJECT_NAME}_docs_sphinx
|
|
COMMAND PYTHONPATH=${PROJECT_BINARY_DIR}/python:$ENV{PYTHONPATH} ${SPHINXBUILD_EXECUTABLE} -j auto -c . -b html ${CMAKE_CURRENT_SOURCE_DIR} html
|
|
)
|
|
|
|
option(Sphinx_Only "When building the documentation, skip the Python Modules and the generation of C++ Api and example outputs" OFF)
|
|
if(NOT Sphinx_Only)
|
|
# Autodoc usage requires the python modules to be built first
|
|
get_property(CPP2PY_MODULES_LIST GLOBAL PROPERTY CPP2PY_MODULES_LIST)
|
|
if(CPP2PY_MODULES_LIST)
|
|
add_dependencies(${PROJECT_NAME}_docs_sphinx ${CPP2PY_MODULES_LIST})
|
|
endif()
|
|
|
|
# Generation of C++ Api and Example Outputs
|
|
add_dependencies(${PROJECT_NAME}_docs_sphinx ${PROJECT_NAME}_docs_cpp2rst ${PROJECT_NAME}_docs_example_output)
|
|
endif()
|
|
|
|
# ---------------------------------
|
|
# Install
|
|
# ---------------------------------
|
|
install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/ COMPONENT documentation DESTINATION share/doc/${PROJECT_NAME}
|
|
FILES_MATCHING
|
|
REGEX "\\.(html|pdf|png|gif|jpg|svg|ico|js|xsl|css|py|txt|inv|bib|ttf|woff2|eot|INCAR|POSCAR|cfg|KPOINTS)$"
|
|
PATTERN "_*"
|
|
)
|