From 8ee7c96ff6ffd8829a0dd29e4a4745eeaeee780f Mon Sep 17 00:00:00 2001 From: Tom Rondeau Date: Tue, 1 May 2012 11:18:31 -0400 Subject: docs: adds a 'make sphinx' target that can be run after 'make install' to generate the Python docs. --- docs/sphinx/CMakeLists.txt | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 docs/sphinx/CMakeLists.txt (limited to 'docs/sphinx/CMakeLists.txt') diff --git a/docs/sphinx/CMakeLists.txt b/docs/sphinx/CMakeLists.txt new file mode 100644 index 000000000..fcae4eb31 --- /dev/null +++ b/docs/sphinx/CMakeLists.txt @@ -0,0 +1,43 @@ +# Copyright 2012 Free Software Foundation, Inc. +# +# This file is part of GNU Radio +# +# GNU Radio is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3, or (at your option) +# any later version. +# +# GNU Radio is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with GNU Radio; see the file COPYING. If not, write to +# the Free Software Foundation, Inc., 51 Franklin Street, +# Boston, MA 02110-1301, USA. + +include(GrPython) + +# You can set these variables from the command line. +set(SPHINXOPTS) +set(SPHINXBUILD sphinx-build) +set(PAPER) +set(BUILDDIR ${CMAKE_CURRENT_BINARY_DIR}/build) +set(SRCDIR ${CMAKE_CURRENT_SOURCE_DIR}/source) + +# Internal variables. +set(PAPEROPT_a4 -D latex_paper_size=a4) +set(PAPEROPT_letter -D latex_paper_size=letter) +set(ALLSPHINXOPTS -d ${BUILDDIR}/doctrees ${PAPEROPT_${PAPER}} ${SPHINXOPTS} ${SRCDIR}) + +# Set up environmental variables to pass to sphinx +set(LDPATH LD_LIBRARY_PATH=${CMAKE_INSTALL_PREFIX}/${GR_LIBRARY_DIR}) +set(PYPATH PYTHONPATH=${CMAKE_INSTALL_PREFIX}/${GR_PYTHON_DIR}) +message(STATUS "ENVIRONS: ${LDPATH} ${PYPATH}") + +add_custom_target(sphinx + COMMAND ${LDPATH} ${PYPATH} ${SPHINX_EXECUTABLE} -b html ${ALLSPHINXOPTS} ${BUILDDIR}/html + COMMENT "Building Sphinx Documents from installed system." + ) + -- cgit From 59165ed2ec7d45a7875c003ce4ce713082cf62c8 Mon Sep 17 00:00:00 2001 From: Tom Rondeau Date: Tue, 1 May 2012 15:37:33 -0400 Subject: sphinx: create a conf.py and run_sphinx_build.sh files. These files help a user run Sphinx on the installed system. The shell script is designed for ease of use. --- docs/sphinx/CMakeLists.txt | 32 ++++++++++++-------------------- 1 file changed, 12 insertions(+), 20 deletions(-) (limited to 'docs/sphinx/CMakeLists.txt') diff --git a/docs/sphinx/CMakeLists.txt b/docs/sphinx/CMakeLists.txt index fcae4eb31..38d77fb3a 100644 --- a/docs/sphinx/CMakeLists.txt +++ b/docs/sphinx/CMakeLists.txt @@ -19,25 +19,17 @@ include(GrPython) -# You can set these variables from the command line. -set(SPHINXOPTS) -set(SPHINXBUILD sphinx-build) -set(PAPER) -set(BUILDDIR ${CMAKE_CURRENT_BINARY_DIR}/build) -set(SRCDIR ${CMAKE_CURRENT_SOURCE_DIR}/source) +configure_file( + ${CMAKE_CURRENT_SOURCE_DIR}/source/conf.py.in + ${CMAKE_CURRENT_BINARY_DIR}/conf.py +@ONLY) -# Internal variables. -set(PAPEROPT_a4 -D latex_paper_size=a4) -set(PAPEROPT_letter -D latex_paper_size=letter) -set(ALLSPHINXOPTS -d ${BUILDDIR}/doctrees ${PAPEROPT_${PAPER}} ${SPHINXOPTS} ${SRCDIR}) - -# Set up environmental variables to pass to sphinx -set(LDPATH LD_LIBRARY_PATH=${CMAKE_INSTALL_PREFIX}/${GR_LIBRARY_DIR}) -set(PYPATH PYTHONPATH=${CMAKE_INSTALL_PREFIX}/${GR_PYTHON_DIR}) -message(STATUS "ENVIRONS: ${LDPATH} ${PYPATH}") - -add_custom_target(sphinx - COMMAND ${LDPATH} ${PYPATH} ${SPHINX_EXECUTABLE} -b html ${ALLSPHINXOPTS} ${BUILDDIR}/html - COMMENT "Building Sphinx Documents from installed system." - ) +configure_file( + ${CMAKE_CURRENT_SOURCE_DIR}/run_sphinx_build.sh.in + ${CMAKE_BINARY_DIR}/run_sphinx_build.sh +@ONLY) +if(UNIX) + #make the shell file executable + execute_process(COMMAND chmod +x ${CMAKE_BINARY_DIR}/run_sphinx_build.sh) +endif(UNIX) -- cgit