generates parent document for doxygen/sphinx

0c2251be · Cristian Lalescu · bcf3821b · 0c2251be · 0c2251be · 0c2251be
Commit 0c2251be authored 3 years ago by Cristian Lalescu
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -202,8 +202,8 @@ pages:
    artifacts:
        paths:
            -  public
-    only:
+#    only:
-      - tags
+#      - tags
    tags:
      - docker
    needs:

--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -29,6 +29,8 @@ cmake_policy(VERSION 3.12)
 project(TurTLE)
+string(TIMESTAMP BUILD_DATE "%Y-%m-%d")
 #####################################################################################
 ## Python and version
@@ -172,6 +174,22 @@ if (SPHINX_FOUND)
            "${PROJECT_SOURCE_DIR}/documentation"
            "${SPHINX_LATEX_DIR}"
            COMMENT "Building LaTeX documentation with Sphinx")
+    if (DOXYGEN_FOUND)
+        set(FULL_DOC_BUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}/public")
+        configure_file(
+            "${PROJECT_SOURCE_DIR}/documentation/index.html.in"
+            "${CMAKE_CURRENT_BINARY_DIR}/doc_full_index.html")
+        configure_file(
+            "${PROJECT_SOURCE_DIR}/documentation/merge_doc_html.sh.in"
+            "${CMAKE_CURRENT_BINARY_DIR}/merge_doc_html.sh")
+        add_custom_target(doc_html_full
+            COMMAND sh merge_doc_html.sh
+            DEPENDS doc_doxygen doc_html
+            WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+            COMMENT "Merging Doxygen and Sphinx HTML documentation")
+    endif()
 else (SPHINX_FOUND)
    message("Sphinx needs to be installed to generate the full documentation")
 endif (SPHINX_FOUND)

--- a/documentation/conf.py.in
+++ b/documentation/conf.py.in
@@ -22,7 +22,7 @@ breathe_projects = {
 # -- Project information -----------------------------------------------------
 project = 'TurTLE'
-copyright = '2021, TurTLE team'
+copyright = '2022, TurTLE team'
 author = 'TurTLE team'
 # The full version, including alpha/beta/rc tags

--- a/documentation/index.html.in
+++ b/documentation/index.html.in
+<html>
+    <title>TurTLE v@TURTLE_VERSION@</title>
+    <h1>TurTLE v@TURTLE_VERSION@</h1>
+    <p>
+    Thank you for browsing the documentation of <a href="https://gitlab.mpcdf.mpg.de/TurTLE/turtle">TurTLE</a>.
+    </p>
+    <p>
+    TurTLE stands for "Turbulence Tools: Lagrangian and Eulerian" and it is
+    developed and maintained by the Wilczek group at the
+    <a href="https://www.ds.mpg.de/wilczek">Max Planck
+        Institute for Dynamics and Self-Organization</a>
+    and the
+    <a href="https://www.wilczek.physik.uni-bayreuth.de/en/team/index.html">
+        University of Bayreuth</a>
+    in collaboration with the Application Support Group of the Max Planck
+    Computing and Data Facility.
+    </p>
+    <p>
+    TurTLE is a framework for
+    pseudo-spectral simulations of turbulence, with a highly optimized particle tracking method.
+    It consists of a C++ core library, as well as a Python "wrapper" library.
+    </p>
+    <p>
+    The documentation consists of two parts:
+    </p>
+    <ul>
+    <li>
+        <a href="doxygen_html/index.html">HTML C++</a> documentation.
+        Full Doxygen output, including, e.g., class index and inheritance graphs.</li>
+    <li>
+        <a href="sphinx_html/index.html">HTML manual</a> generated with Sphinx.
+        This contains tutorials, the Python library documentation, and part of the C++ Doxygen output.
+    </li>
+    </ul>
+    <footer>
+        Last updated @BUILD_DATE@.
+    </footer>
+</html>
--- a/documentation/merge_doc_html.sh.in
+++ b/documentation/merge_doc_html.sh.in
+#! /usr/bin/env bash
+mkdir -p public
+cp -r \
+    @CMAKE_CURRENT_BINARY_DIR@/html \
+    @CMAKE_CURRENT_BINARY_DIR@/public/doxygen_html
+cp -r \
+    @CMAKE_CURRENT_BINARY_DIR@/sphinx_html \
+    @CMAKE_CURRENT_BINARY_DIR@/public/sphinx_html
+cp \
+    @CMAKE_CURRENT_BINARY_DIR@/doc_full_index.html \
+    @CMAKE_CURRENT_BINARY_DIR@/public/index.html