summaryrefslogtreecommitdiff
path: root/cmake/Modules/FindSphinx.cmake
diff options
context:
space:
mode:
authorTom Rondeau2012-05-01 11:18:31 -0400
committerTom Rondeau2012-05-01 11:29:14 -0400
commit8ee7c96ff6ffd8829a0dd29e4a4745eeaeee780f (patch)
tree4e55882d592625c19ab91fdf396db9cec8050529 /cmake/Modules/FindSphinx.cmake
parent141d2ec0a0c3d9c234622444b1f2a5e21fa08ae8 (diff)
downloadgnuradio-8ee7c96ff6ffd8829a0dd29e4a4745eeaeee780f.tar.gz
gnuradio-8ee7c96ff6ffd8829a0dd29e4a4745eeaeee780f.tar.bz2
gnuradio-8ee7c96ff6ffd8829a0dd29e4a4745eeaeee780f.zip
docs: adds a 'make sphinx' target that can be run after 'make install' to generate the Python docs.
Diffstat (limited to 'cmake/Modules/FindSphinx.cmake')
-rw-r--r--cmake/Modules/FindSphinx.cmake37
1 files changed, 37 insertions, 0 deletions
diff --git a/cmake/Modules/FindSphinx.cmake b/cmake/Modules/FindSphinx.cmake
new file mode 100644
index 000000000..da12ee93d
--- /dev/null
+++ b/cmake/Modules/FindSphinx.cmake
@@ -0,0 +1,37 @@
+# - This module looks for Sphinx
+# Find the Sphinx documentation generator
+#
+# This modules defines
+# SPHINX_EXECUTABLE
+# SPHINX_FOUND
+
+#=============================================================================
+# Copyright 2002-2009 Kitware, Inc.
+# Copyright 2009-2011 Peter Colberg
+#
+# Distributed under the OSI-approved BSD License (the "License");
+# see accompanying file COPYING-CMAKE-SCRIPTS for details.
+#
+# This software is distributed WITHOUT ANY WARRANTY; without even the
+# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+# See the License for more information.
+#=============================================================================
+# (To distribute this file outside of CMake, substitute the full
+# License text for the above reference.)
+
+find_program(SPHINX_EXECUTABLE NAMES sphinx-build
+ HINTS
+ $ENV{SPHINX_DIR}
+ PATH_SUFFIXES bin
+ DOC "Sphinx documentation generator"
+)
+
+include(FindPackageHandleStandardArgs)
+
+find_package_handle_standard_args(Sphinx DEFAULT_MSG
+ SPHINX_EXECUTABLE
+)
+
+mark_as_advanced(
+ SPHINX_EXECUTABLE
+)