# The following will be generated or updated when the 'doc' target is built: # • user guide and man pages: if BUILD_DOCS is set # • HTML versions of the above: if BUILD_DOCS and BUILD_WEB_DOCS are set # • Doxygen / reference documentation: if USE_DOXYGEN is set ######################################################################## if (USE_DOXYGEN) find_package(Doxygen) if(NOT DOXYGEN_FOUND) message(FATAL_ERROR "Could not find doxygen. Reference documentation cannot be built.") endif() configure_file(Doxyfile.in Doxyfile @ONLY) # see INPUT/FILE_PATTERNS in Doxyfile.in file(GLOB doxygen_input_files ${CMAKE_SOURCE_DIR}/src/*.h) add_custom_command(OUTPUT html/index.html COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile DEPENDS Doxyfile ${doxygen_input_files} COMMENT "Building doxygen documentation") add_custom_target(doc.doxygen DEPENDS html/index.html) else() add_custom_target(doc.doxygen) endif() ######################################################################## if(NOT BUILD_DOCS) add_custom_target(doc DEPENDS doc.doxygen) return() endif() set(info_files ledger3.texi ledger-mode.texi) find_program(MAKEINFO makeinfo) find_program(TEXI2PDF texi2pdf) find_program(TEX tex) find_program(MAN2HTML man2html) find_program(GROFF groff) ######################################################################## foreach(file ${info_files}) get_filename_component(file_base ${file} NAME_WE) if(NOT MAKEINFO) message(WARNING "Could not find makeinfo. Info version of documentation cannot be built.") else() add_custom_command(OUTPUT ${file_base}.info COMMAND makeinfo --force --no-split -o ${file_base}.info ${CMAKE_CURRENT_SOURCE_DIR}/${file} DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/${file} VERBATIM) list(APPEND ledger_doc_files ${file_base}.info) endif() if(BUILD_WEB_DOCS) if(NOT MAKEINFO) message(WARNING "Could not find makeinfo. HTML version of documentation cannot be built.") endif() add_custom_command(OUTPUT ${file_base}.html COMMAND makeinfo --force --html --no-split -o ${file_base}.html ${CMAKE_CURRENT_SOURCE_DIR}/${file} DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/${file} VERBATIM) list(APPEND ledger_doc_files ${file_base}.html) endif(BUILD_WEB_DOCS) if(NOT TEXI2PDF OR NOT TEX) message(WARNING "Could not find texi2pdf or tex. PDF version of documentation will not be built.") else() if(BUILD_A4_PDF) set(papersize --texinfo=@afourpaper) endif() add_custom_command(OUTPUT ${file_base}.pdf COMMAND texi2pdf ${papersize} -b -q -o ${file_base}.pdf ${CMAKE_CURRENT_SOURCE_DIR}/${file} DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/${file} VERBATIM) list(APPEND ledger_doc_files ${file_base}.pdf) endif() endforeach() ######################################################################## if(BUILD_WEB_DOCS) include(FindUnixCommands) if(NOT BASH) message(FATAL_ERROR "Could not find bash. Unable to build documentation.") endif() if(MAN2HTML) add_custom_command(OUTPUT ledger.1.html COMMAND ${BASH} -c "man2html ${CMAKE_CURRENT_SOURCE_DIR}/ledger.1 | tail -n+3 > ledger.1.html" DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/ledger.1 VERBATIM) list(APPEND ledger_doc_files ledger.1.html) elseif(GROFF) add_custom_command(OUTPUT ledger.1.html COMMAND ${BASH} -c "groff -mandoc -Thtml ${CMAKE_CURRENT_SOURCE_DIR}/ledger.1 > ledger.1.html" DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/ledger.1 VERBATIM) list(APPEND ledger_doc_files ledger.1.html) else() message(FATAL_ERROR "Could not find man2html or groff. HTML version of man page cannot be built.") endif() endif(BUILD_WEB_DOCS) ######################################################################## add_custom_target(doc DEPENDS ${ledger_doc_files} doc.doxygen) ######################################################################## include(GNUInstallDirs) if(CMAKE_INSTALL_MANDIR) install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/ledger.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1 COMPONENT doc) endif(CMAKE_INSTALL_MANDIR) foreach(file ${info_files}) get_filename_component(file_base ${file} NAME_WE) if (CMAKE_SOURCE_DIR STREQUAL BUILD_DIR) set(doc_dir ${CMAKE_CURRENT_SOURCE_DIR}) else() get_filename_component(dir_base ${CMAKE_CURRENT_SOURCE_DIR} NAME_WE) set(doc_dir "${CMAKE_SOURCE_DIR}/${BUILD_DIR}/${dir_base}") endif() install(FILES ${doc_dir}/${file_base}.info DESTINATION ${CMAKE_INSTALL_INFODIR} COMPONENT doc) install(FILES ${doc_dir}/${file_base}.pdf DESTINATION ${CMAKE_INSTALL_DOCDIR} COMPONENT doc OPTIONAL) if (BUILD_WEB_DOCS) install(FILES ${doc_dir}/${file_base}.html DESTINATION ${CMAKE_INSTALL_DOCDIR} COMPONENT doc) endif(BUILD_WEB_DOCS) endforeach()