From 38f2ae399a443ffa6f215c5d3c8ff2329de333ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20Mr=C3=A1zek?= Date: Sat, 29 Sep 2012 03:30:38 +0200 Subject: [PATCH] Generate html documentation as part of the normal build. --- CMakeLists.txt | 21 ++++++++++++++++++++- fixTexts.sh | 5 ----- testTexts.sh | 5 +++++ 3 files changed, 25 insertions(+), 6 deletions(-) delete mode 100755 fixTexts.sh create mode 100755 testTexts.sh diff --git a/CMakeLists.txt b/CMakeLists.txt index 9bd4ad974..ee3f1d2e6 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -147,11 +147,30 @@ add_subdirectory(depends) find_package(Docutils) +set (RST_FILES +README +COMPILE +LUA_API +) + +set (RST_PROCESSED_FILES "") +IF(RST2HTML_EXECUTABLE) + foreach(F ${RST_FILES}) + add_custom_command( + OUTPUT "${dfhack_BINARY_DIR}/${F}.html" + COMMAND ${RST2HTML_EXECUTABLE} "${dfhack_SOURCE_DIR}/${F}.rst" > "${dfhack_BINARY_DIR}/${F}.html" + COMMENT "Translating ${F} to html" + DEPENDS "${dfhack_SOURCE_DIR}/${F}.rst") + list (APPEND RST_PROCESSED_FILES "${dfhack_BINARY_DIR}/${F}.html") + endforeach() + add_custom_target(HTML_DOCS ALL DEPENDS ${RST_PROCESSED_FILES}) +ENDIF() + # build the lib itself IF(BUILD_LIBRARY) add_subdirectory (library) ## install the default documentation files - install(FILES LICENSE Readme.html Compile.html Lua\ API.html DESTINATION ${DFHACK_USERDOC_DESTINATION}) + install(FILES LICENSE ${RST_PROCESSED_FILES} DESTINATION ${DFHACK_USERDOC_DESTINATION}) endif() #build the plugins diff --git a/fixTexts.sh b/fixTexts.sh deleted file mode 100755 index 669fa068b..000000000 --- a/fixTexts.sh +++ /dev/null @@ -1,5 +0,0 @@ -#!/bin/bash -rst2html README.rst > Readme.html -rst2html COMPILE.rst > Compile.html -rst2html DEVEL.rst > Devel.html -rst2html LUA_API.rst > Lua\ API.html diff --git a/testTexts.sh b/testTexts.sh new file mode 100755 index 000000000..0189ae2a2 --- /dev/null +++ b/testTexts.sh @@ -0,0 +1,5 @@ +#!/bin/bash +# this script is used for easy testing of the rst documentation files. +rst2html README.rst > README.html +rst2html COMPILE.rst > COMPILE.html +rst2html LUA_API.rst > LUA_API.html