Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This commit introduces a docs target which translates `.rst` files into man pages or HTML documents and installs them in `/usr/share/man/man1` or `/usr/share/doc/revamb`.
- Loading branch information
1 parent
89d4978
commit d416843
Showing
2 changed files
with
46 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# | ||
# This file is distributed under the MIT License. See LICENSE.md for details. | ||
# | ||
|
||
set(MAN_PAGES RevambDumpUsage.rst RevambUsage.rst TranslateUsage.rst) | ||
set(DOC_HTML BuildSystem.rst FromIRToExecutable.rst GeneratedIRReference.rst | ||
PythonExample.rst) | ||
set(DOC_COPY instrument.py) | ||
|
||
set(DOC_DEPS) | ||
|
||
find_program(RST2MAN rst2man.py) | ||
if(NOT "${RST2MAN}" STREQUAL RST2MAN-NOTFOUND) | ||
foreach(INPUT_FILE ${MAN_PAGES}) | ||
string(REPLACE ".rst" ".1" OUTPUT_FILE "${INPUT_FILE}") | ||
add_custom_command(OUTPUT "${OUTPUT_FILE}" | ||
COMMAND "${RST2MAN}" "${CMAKE_CURRENT_SOURCE_DIR}/${INPUT_FILE}" > "${OUTPUT_FILE}" | ||
MAIN_DEPENDENCY "${INPUT_FILE}") | ||
set(DOC_DEPS ${DOC_DEPS} ${OUTPUT_FILE}) | ||
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${OUTPUT_FILE} | ||
DESTINATION ${CMAKE_INSTALL_PREFIX}/share/man/man1) | ||
endforeach() | ||
endif() | ||
|
||
find_program(RST2HTML rst2html.py) | ||
if(NOT "${RST2HTML}" STREQUAL RST2HTML-NOTFOUND) | ||
foreach(INPUT_FILE ${DOC_HTML}) | ||
string(REPLACE ".rst" ".html" OUTPUT_FILE "${INPUT_FILE}") | ||
add_custom_command(OUTPUT "${OUTPUT_FILE}" | ||
COMMAND "${RST2HTML}" "${CMAKE_CURRENT_SOURCE_DIR}/${INPUT_FILE}" > "${OUTPUT_FILE}" | ||
MAIN_DEPENDENCY "${INPUT_FILE}") | ||
set(DOC_DEPS ${DOC_DEPS} ${OUTPUT_FILE}) | ||
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${OUTPUT_FILE} | ||
DESTINATION ${CMAKE_INSTALL_PREFIX}/share/doc/revamb/) | ||
endforeach() | ||
endif() | ||
|
||
foreach(INPUT_FILE ${DOC_COPY}) | ||
configure_file("${CMAKE_CURRENT_SOURCE_DIR}/${INPUT_FILE}" "${INPUT_FILE}" COPYONLY) | ||
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${INPUT_FILE} | ||
DESTINATION ${CMAKE_INSTALL_PREFIX}/share/doc/revamb/) | ||
endforeach() | ||
|
||
add_custom_target(docs ALL DEPENDS ${DOC_DEPS}) |