1# Copyright (c) 2015, Intel Corporation
2# All rights reserved.
3#
4# Redistribution and use in source and binary forms, with or without modification,
5# are permitted provided that the following conditions are met:
6#
7# 1. Redistributions of source code must retain the above copyright notice, this
8# list of conditions and the following disclaimer.
9#
10# 2. Redistributions in binary form must reproduce the above copyright notice,
11# this list of conditions and the following disclaimer in the documentation and/or
12# other materials provided with the distribution.
13#
14# 3. Neither the name of the copyright holder nor the names of its contributors
15# may be used to endorse or promote products derived from this software without
16# specific prior written permission.
17#
18# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
22# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
25# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29if(REQUIREMENTS)
30    find_program(PANDOC pandoc)
31
32    if(NOT PANDOC)
33        message(SEND_ERROR
34                "'pandoc' executable has not been found."
35                " Please install it to be able to generate the html version of"
36                " the 'requirements' documentation.")
37    endif()
38
39    configure_file(requirements.css
40                   ${CMAKE_CURRENT_BINARY_DIR}/requirements.css
41                   COPYONLY)
42
43    set(REQ_OUT_DOC ${CMAKE_CURRENT_BINARY_DIR}/index.html)
44
45    add_custom_target(requirements-doc DEPENDS ${REQ_OUT_DOC})
46
47    add_custom_command(OUTPUT ${REQ_OUT_DOC}
48                       DEPENDS requirements.md requirements.css
49                       VERBATIM COMMAND
50        ${PANDOC} --output ${REQ_OUT_DOC}
51                  --from markdown --to html5
52                  --number-sections --table-of-contents
53                  --smart # typographic dashes
54                  --variable "pagetitle:Parameter Framework Requirements"
55                  --id-prefix req- # avoid tag name conflicts
56                  --css requirements.css # this path is relative to the html doc
57                  --css http://sindresorhus.com/github-markdown-css/github-markdown.css
58                  ${CMAKE_CURRENT_SOURCE_DIR}/requirements.md)
59endif()
60