uhd

#

# Copyright 2010 Ettus Research LLC

#

# This program 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 of the License, or

# (at your option) any later version.

#

# This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.

#

########################################################################

# List of manual sources

########################################################################

SET(manual_sources

    index.rst

    build.rst

    coding.rst

    dboards.rst

    general.rst

    images.rst

    usrp2.rst

)

########################################################################

# Setup Manual

########################################################################

MESSAGE(STATUS "Checking for rst2html (docutils)")

FIND_PROGRAM(RST2HTML rst2html)

IF(${RST2HTML} STREQUAL "RST2HTML-NOTFOUND")

    MESSAGE(STATUS "Checking for rst2html (docutils) - not found")

    MESSAGE(STATUS "  Disabled generation of HTML manual.")

ELSE(${RST2HTML} STREQUAL "RST2HTML-NOTFOUND")

    MESSAGE(STATUS "Checking for rst2html (docutils) - found")

    MESSAGE(STATUS "  Enabled generation of HTML manual.")

    #setup rst2html options

    SET(stylesheet ${CMAKE_CURRENT_SOURCE_DIR}/style.css)

    SET(rst2html_options

        --stylesheet=${stylesheet}

        --no-toc-backlinks --date --time

    )

    #create generation rule for each source

    FOREACH(rstfile ${manual_sources})

        #set input and output file names

        SET(rstfile ${CMAKE_CURRENT_SOURCE_DIR}/${rstfile})

        GET_FILENAME_COMPONENT(rstfile_we ${rstfile} NAME_WE)

        SET(htmlfile ${CMAKE_CURRENT_BINARY_DIR}/${rstfile_we}.html)

        #make the html file depend on the rst file

        ADD_CUSTOM_COMMAND(

            OUTPUT ${htmlfile} DEPENDS ${rstfile} ${stylesheet}

            COMMAND ${RST2HTML} ${rstfile} ${htmlfile} ${rst2html_options}

            COMMENT "Generating ${htmlfile}"

        )

        #make the manual target depend on the html file

        LIST(APPEND manual_html_files ${htmlfile})

        INSTALL(FILES ${htmlfile} DESTINATION ${PKG_DOC_DIR}/manual/html)

    ENDFOREACH(rstfile ${manual_sources})

    #make the html manual a build-time dependency

    ADD_CUSTOM_TARGET(manual_html ALL DEPENDS ${manual_html_files})

ENDIF(${RST2HTML} STREQUAL "RST2HTML-NOTFOUND")

INSTALL(FILES ${manual_sources} DESTINATION ${PKG_DOC_DIR}/manual/rst)

########################################################################

# Setup Doxygen

########################################################################

INCLUDE(FindDoxygen)

IF(DOXYGEN_FOUND)

    MESSAGE(STATUS "  Enabled generation of Doxygen documentation.")

    #generate the doxygen configuration file

    SET(CMAKE_CURRENT_BINARY_DIR_DOXYGEN ${CMAKE_CURRENT_BINARY_DIR}/doxygen)

    CONFIGURE_FILE(

        ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in

        ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile

    @ONLY)

    #make doxygen directory depend on the header files

    FILE(GLOB_RECURSE header_files ${CMAKE_SOURCE_DIR}/include/*.hpp)

    ADD_CUSTOM_COMMAND(

        OUTPUT ${CMAKE_CURRENT_BINARY_DIR_DOXYGEN} DEPENDS ${header_files}

        COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile

        COMMENT "Generating documentation with doxygen"

    )

    #make the doxygen generation a built-time dependency

    ADD_CUSTOM_TARGET(doxygen_docs ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR_DOXYGEN})

    INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR_DOXYGEN} DESTINATION ${PKG_DOC_DIR})

ELSE(DOXYGEN_FOUND)

    MESSAGE(STATUS "  Disabled generation of Doxygen documentation.")

ENDIF(DOXYGEN_FOUND)