mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-08 13:23:51 +00:00
56 lines
1.8 KiB
CMake
56 lines
1.8 KiB
CMake
##============================================================================
|
|
## Copyright (c) Kitware, Inc.
|
|
## All rights reserved.
|
|
## See LICENSE.txt for details.
|
|
##
|
|
## This software is distributed WITHOUT ANY WARRANTY; without even
|
|
## the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
## PURPOSE. See the above copyright notice for more information.
|
|
##============================================================================
|
|
|
|
# This module is always loaded so that the example code is compiled as part
|
|
# of the test build. However, we only really want to build the document if
|
|
# VTKm_ENABLE_USERS_GUIDE is set.
|
|
if (NOT VTKm_ENABLE_USERS_GUIDE)
|
|
return()
|
|
endif()
|
|
|
|
set(sphinx_docs
|
|
index.rst
|
|
)
|
|
|
|
find_package(Sphinx)
|
|
if (NOT Sphinx_FOUND)
|
|
message(FATAL_ERROR
|
|
"Could not find Sphinx to build User's Guide. If you want to compile Doxygen without the User's Guide, turn off VTKm_ENABLE_USERS_GUIDE.")
|
|
endif()
|
|
|
|
option(VTKm_USERS_GUIDE_INCLUDE_TODOS
|
|
"When building the VTK-m User's Guide, specify whether to include TODO notes." ON)
|
|
mark_as_advanced(VTKm_USERS_GUIDE_INCLUDE_TODOS)
|
|
|
|
# Configuration used in conf.py.
|
|
set(doxygen_xml_output_dir "${VTKm_BINARY_DIR}/docs/doxygen/xml")
|
|
set(example_directory "${CMAKE_CURRENT_SOURCE_DIR}/examples")
|
|
if(VTKm_USERS_GUIDE_INCLUDE_TODOS)
|
|
set(include_todos "True")
|
|
else()
|
|
set(include_todos "False")
|
|
endif()
|
|
|
|
sphinx_add_docs(VTKmUsersGuideHTML
|
|
BUILDER html
|
|
SOURCE_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
|
|
OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html
|
|
CONF_FILE conf.py
|
|
)
|
|
add_dependencies(VTKmUsersGuideHTML VTKmDoxygenDocs)
|
|
|
|
sphinx_add_docs(VTKmUsersGuideLaTeX
|
|
BUILDER latex
|
|
SOURCE_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
|
|
OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/latex
|
|
CONF_FILE conf.py
|
|
)
|
|
add_dependencies(VTKmUsersGuideLaTeX VTKmDoxygenDocs)
|