From ff3c32a5fce9e3c1cc563a7aa30f542c1fd5b5ae Mon Sep 17 00:00:00 2001
From: Dominic Kempf <dominic.r.kempf@gmail.com>
Date: Thu, 15 Oct 2015 14:37:47 +0200
Subject: [PATCH] [bugfix] Fix the documentation procedure with installed
modules
---
cmake/modules/DuneSphinxCMakeDoc.cmake | 14 ++++++++++++--
cmake/scripts/CMakeLists.txt | 2 ++
doc/CMakeLists.txt | 2 --
doc/buildsystem/CMakeLists.txt | 3 +++
4 files changed, 17 insertions(+), 4 deletions(-)
diff --git a/cmake/modules/DuneSphinxCMakeDoc.cmake b/cmake/modules/DuneSphinxCMakeDoc.cmake
index 0db36529a..99cbf98e1 100644
--- a/cmake/modules/DuneSphinxCMakeDoc.cmake
+++ b/cmake/modules/DuneSphinxCMakeDoc.cmake
@@ -70,12 +70,22 @@ function(dune_cmake_sphinx_doc)
set(CMAKE_DOC_DEPENDENCIES "")
set(${CMAKE_PROJECT_NAME}_PREFIX ${CMAKE_SOURCE_DIR})
foreach(dep ${ALL_DEPENDENCIES} ${CMAKE_PROJECT_NAME})
- # Check whether the module dep has specified some build system docs.
+ # Look for a build system documentation exported by the module dep
+ set(RSTFILE "")
+ # check in the correct path for non-installed modules
if(EXISTS ${${dep}_PREFIX}/doc/buildsystem/${dep}.rst)
+ set(RSTFILE ${${dep}_PREFIX}/doc/buildsystem/${dep}.rst)
+ endif()
+ # now check for the correct path taking into account installed ones
+ if(EXISTS ${${dep}_PREFIX}/share/doc/${dep}/${dep}.rst)
+ set(RSTFILE ${${dep}_PREFIX}/share/doc/${dep}/${dep}.rst)
+ endif()
+ # Now process the file, if we have found one
+ if(RSTFILE)
# add it to index.rst then.
set(CMAKE_DOC_DEPENDENCIES "${CMAKE_DOC_DEPENDENCIES} ${dep}\n")
# ... and copy the rst file to the current build.
- configure_file(${${dep}_PREFIX}/doc/buildsystem/${dep}.rst ${CMAKE_CURRENT_BINARY_DIR}/${dep}.rst)
+ configure_file(${RSTFILE} ${CMAKE_CURRENT_BINARY_DIR}/${dep}.rst)
endif()
endforeach()
configure_file(${DUNE_SPHINX_EXT_PATH}/index.rst.in ${CMAKE_CURRENT_BINARY_DIR}/index.rst)
diff --git a/cmake/scripts/CMakeLists.txt b/cmake/scripts/CMakeLists.txt
index ee36fc83b..b76a353ea 100644
--- a/cmake/scripts/CMakeLists.txt
+++ b/cmake/scripts/CMakeLists.txt
@@ -1,8 +1,10 @@
set(modules
+ conf.py.in
CreateDoxyFile.cmake
extract_cmake_data.py
FinalizeHeadercheck.cmake
FindFiles.cmake
+ index.rst.in
InstallFile.cmake
RunDoxygen.cmake
sphinx_cmake_dune.py)
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index fc17e9fde..56c3aa475 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -1,7 +1,5 @@
add_subdirectory("doxygen")
add_subdirectory("buildsystem")
add_subdirectory("comm")
-install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/example.opts
- DESTINATION ${CMAKE_INSTALL_DOCDIR})
install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/dunecontrol.1
DESTINATION ${CMAKE_INSTALL_MANDIR}/man1)
diff --git a/doc/buildsystem/CMakeLists.txt b/doc/buildsystem/CMakeLists.txt
index ae6d42ff4..28a1ceb01 100644
--- a/doc/buildsystem/CMakeLists.txt
+++ b/doc/buildsystem/CMakeLists.txt
@@ -1,2 +1,5 @@
+# Install the buildsystem documentation defined in dune-common
+install(FILES dune-common.rst DESTINATION ${CMAKE_INSTALL_DOCDIR})
+
# Also always build the CMake API documentation in dune-common
dune_cmake_sphinx_doc()
--
GitLab