Merge pull request #676 from sebproell/docs-structuring

Organize documentation into subfolders

Author: sebproell

README.md

@@ -11,4 +11,3 @@ set(OBJS_CREATERTD
 add_executable(create_rtd EXCLUDE_FROM_ALL ${OBJS_CREATERTD})
 set_target_properties(create_rtd PROPERTIES RUNTIME_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR})
 four_c_set_up_executable(create_rtd)
-add_custom_target(rtd DEPENDS create_rtd)

apps/create_rtdfiles/CMakeLists.txt

@@ -43,7 +43,7 @@ if(FOUR_C_BUILD_DOCUMENTATION)
       ${_sphinx_OUT_DIR}/reference_docs/4C-cmake-presets.txt
     COMMAND
       ${SPHINX_EXECUTABLE} -W -n -q -b html # warnings are errors and be nit-picky
-      -i "${CMAKE_CURRENT_SOURCE_DIR}" -i "${_sphinx_OUT_DIR}/reference_docs" -i
+      -i "${CMAKE_CURRENT_SOURCE_DIR}/src" -i "${_sphinx_OUT_DIR}/reference_docs" -i
       "${PROJECT_SOURCE_DIR}/tests/framework-test" -i "${_sphinx_TPLDEPEND_DIR}" -o
       "${_sphinx_HTML_DIR}" -c "${_sphinx_OUT_DIR}" -s "${PROJECT_BINARY_DIR}/doc/tmp"
     DEPENDS create_rtd ${FOUR_C_EXECUTABLE_NAME}

doc/documentation/CMakeLists.txt

@@ -12,8 +12,8 @@
 import sys
 import os
 # sys.path.append(os.path.abspath('.../site-packages/sphinx/ext'))
-sys.path.append('@PROJECT_BINARY_DIR@/doc/tmp/python')
-#
+# Include our own python helper modules
+sys.path.append('@PROJECT_SOURCE_DIR@/doc/documentation/python')
 import plot