X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=manual%2FCMakeLists.txt;fp=manual%2FCMakeLists.txt;h=c425f36b3bdd7eb3cf246b6c593a97218a8edcfd;hb=3782d8609d2f4bd66855dc4f72c0f74d9bc11c23;hp=0000000000000000000000000000000000000000;hpb=4deee4de1660cd5cdc100f3130a3e68af97212d9;p=pulseview.git diff --git a/manual/CMakeLists.txt b/manual/CMakeLists.txt new file mode 100644 index 00000000..c425f36b --- /dev/null +++ b/manual/CMakeLists.txt @@ -0,0 +1,87 @@ +## +## This file is part of the PulseView project. +## +## Copyright (C) 2018 Gerhard Sittig +## +## 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 2 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 . +## + +cmake_minimum_required(VERSION 2.8.12) + +# External dependencies, required and optional tools. +find_program(ASCIIDOCTOR_EXECUTABLE NAMES asciidoctor) +find_program(ASCIIDOCTOR_PDF_EXECUTABLE NAMES asciidoctor-pdf) + +# Tunables. +set(STYLES_DIR "asciidoctor-stylesheet-factory/stylesheets") +set(STYLE_SHEET "readthedocs.css") + +# Input files. +set(MANUAL_SRC "${CMAKE_CURRENT_SOURCE_DIR}/manual.txt") + +# Output files, conversion results. +set(MANUAL_OUT_HTML "${CMAKE_CURRENT_BINARY_DIR}/manual.html") +set(MANUAL_OUT_PDF "${CMAKE_CURRENT_BINARY_DIR}/manual.pdf") + +# Manual related make(1) targets. +add_custom_target(manual-html + COMMAND ${ASCIIDOCTOR_EXECUTABLE} + -a stylesheet=${STYLE_SHEET} + -a stylesdir=${CMAKE_CURRENT_SOURCE_DIR}/${STYLES_DIR} + -a toc=left + --destination-dir=${CMAKE_CURRENT_BINARY_DIR} + ${MANUAL_SRC} + BYPRODUCTS ${MANUAL_OUT_HTML} + DEPENDS ${MANUAL_SRC} + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + COMMENT "Generating manual, HTML output" +) +if (ASCIIDOCTOR_PDF_EXECUTABLE) + add_custom_target(manual-pdf + COMMAND ${ASCIIDOCTOR_PDF_EXECUTABLE} + -a stylesheet=${STYLE_SHEET} + -a stylesdir=${CMAKE_CURRENT_SOURCE_DIR}/${STYLES_DIR} + --destination-dir=${CMAKE_CURRENT_BINARY_DIR} + ${MANUAL_SRC} + BYPRODUCTS ${MANUAL_OUT_PDF} + DEPENDS ${MANUAL_SRC} + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + COMMENT "Generating manual, HTML output" + ) +else () + add_custom_target(manual-pdf + COMMAND ${CMAKE_COMMAND} -E echo + "asciidoctor-pdf executable is missing, NOT generating PDF output" + DEPENDS ${MANUAL_SRC} + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + ) +endif () +add_custom_target(manual) +add_dependencies(manual manual-html manual-pdf) + +set(MANUAL_INST_SUBDIR "share/doc/pulseview") +install( + FILES ${MANUAL_OUT_HTML} ${MANUAL_OUT_PDF} + DESTINATION ${MANUAL_INST_SUBDIR} + PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ + OPTIONAL +) +if (ASCIIDOCTOR_EXECUTABLE) + install( + DIRECTORY images + DESTINATION ${MANUAL_INST_SUBDIR} + FILE_PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ + PATTERN "*.xcf" EXCLUDE + ) +endif ()