xref: /aosp_15_r20/external/llvm/cmake/modules/FindSphinx.cmake (revision 9880d6810fe72a1726cb53787c6711e909410d58)
1*9880d681SAndroid Build Coastguard Worker# CMake find_package() Module for Sphinx documentation generator
2*9880d681SAndroid Build Coastguard Worker# http://sphinx-doc.org/
3*9880d681SAndroid Build Coastguard Worker#
4*9880d681SAndroid Build Coastguard Worker# Example usage:
5*9880d681SAndroid Build Coastguard Worker#
6*9880d681SAndroid Build Coastguard Worker# find_package(Sphinx)
7*9880d681SAndroid Build Coastguard Worker#
8*9880d681SAndroid Build Coastguard Worker# If successful the following variables will be defined
9*9880d681SAndroid Build Coastguard Worker# SPHINX_FOUND
10*9880d681SAndroid Build Coastguard Worker# SPHINX_EXECUTABLE
11*9880d681SAndroid Build Coastguard Worker
12*9880d681SAndroid Build Coastguard Workerfind_program(SPHINX_EXECUTABLE
13*9880d681SAndroid Build Coastguard Worker             NAMES sphinx-build sphinx-build2
14*9880d681SAndroid Build Coastguard Worker             DOC "Path to sphinx-build executable")
15*9880d681SAndroid Build Coastguard Worker
16*9880d681SAndroid Build Coastguard Worker# Handle REQUIRED and QUIET arguments
17*9880d681SAndroid Build Coastguard Worker# this will also set SPHINX_FOUND to true if SPHINX_EXECUTABLE exists
18*9880d681SAndroid Build Coastguard Workerinclude(FindPackageHandleStandardArgs)
19*9880d681SAndroid Build Coastguard Workerfind_package_handle_standard_args(Sphinx
20*9880d681SAndroid Build Coastguard Worker                                  "Failed to locate sphinx-build executable"
21*9880d681SAndroid Build Coastguard Worker                                  SPHINX_EXECUTABLE)
22*9880d681SAndroid Build Coastguard Worker
23*9880d681SAndroid Build Coastguard Worker# Provide options for controlling different types of output
24*9880d681SAndroid Build Coastguard Workeroption(SPHINX_OUTPUT_HTML "Output standalone HTML files" ON)
25*9880d681SAndroid Build Coastguard Workeroption(SPHINX_OUTPUT_MAN "Output man pages" ON)
26*9880d681SAndroid Build Coastguard Worker
27*9880d681SAndroid Build Coastguard Workeroption(SPHINX_WARNINGS_AS_ERRORS "When building documentation treat warnings as errors" ON)
28