FindSphinx.cmake File Reference

Find Sphinx documentation build tools. More...

#include "FindPackageHandleStandardArgs.cmake"

Include dependency graph for FindSphinx.cmake:

Go to the source code of this file.

Variables
cmake	Sphinx_DIR
cmake	SPHINX_EXECUTABLE
cmake	Sphinx_FIND_COMPONENTS
cmake	Sphinx_PYTHON_EXECUTABLE
cmake	Sphinx_VERSION_STRING

---

Detailed Description

Find Sphinx documentation build tools.

Input variables:

Sphinx_DIR	Installation directory of Sphinx tools. Can also be set as environment variable.
SPHINX_DIR	Alternative environment variable for Sphinx_DIR.
Sphinx_FIND_COMPONENTS	Sphinx build tools to look for, i.e., 'apidoc' and/or 'build'.

Output variables:

Sphinx_FOUND	Whether all or only the requested Sphinx build tools were found.
SPHINX_FOUND	Alias for Sphinx_FOUND.
SPHINX_EXECUTABLE	Non-cached alias for Sphinx-build_EXECUTABLE.
Sphinx_PYTHON_EXECUTABLE	Python executable used to run sphinx-build. This is either the by default found Python interpreter or a specific version as specified by the shebang (#!) of the sphinx-build script.
Sphinx_PYTHON_OPTIONS	A list of Python options extracted from the shebang (#!) of the sphinx-build script. The -E option is added by this module if the Python executable is not the system default to avoid problems with a differing setting of the PYTHONHOME.
Sphinx-build_EXECUTABLE	Absolute path of the found sphinx-build tool.
Sphinx-apidoc_EXECUTABLE	Absolute path of the found sphinx-apidoc tool.
Sphinx_VERSION_STRING	Sphinx version found e.g. 1.1.2.
Sphinx_VERSION_MAJOR	Sphinx major version found e.g. 1.
Sphinx_VERSION_MINOR	Sphinx minor version found e.g. 1.
Sphinx_VERSION_PATCH	Sphinx patch version found e.g. 2.

Definition in file FindSphinx.cmake.

---

Variable Documentation

cmake Sphinx_DIR

Definition at line 77 of file FindSphinx.cmake.

cmake SPHINX_EXECUTABLE

Definition at line 177 of file FindSphinx.cmake.

cmake Sphinx_FIND_COMPONENTS

Definition at line 92 of file FindSphinx.cmake.

cmake Sphinx_PYTHON_EXECUTABLE

Definition at line 125 of file FindSphinx.cmake.

cmake Sphinx_VERSION_STRING

Definition at line 164 of file FindSphinx.cmake.