Merge pull request codac-team#331 from SimonRohou/codac2_dev

Doc + contractors

Author: SimonRohou

doc/CMakeLists.txt

@@ -33,13 +33,13 @@
       endif()
 
       message(STATUS "Building API Documentation (mandatory for Python binding or for building the manual)")
+
+      set(SPHINX_EXTRA_API ${CMAKE_CURRENT_BINARY_DIR}/manual/extra_html/api)
+      file(MAKE_DIRECTORY ${SPHINX_EXTRA_API})
+
       execute_process(COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_INPUT} OUTPUT_QUIET)
       add_custom_target(api COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_INPUT} OUTPUT_QUIET)
 
-      install(DIRECTORY ${CMAKE_BINARY_DIR}/doc/api/html 
-              DESTINATION share/doc/${CMAKE_PROJECT_NAME}/api
-              OPTIONAL)
-
     endif()
 
   endif()
@@ -87,6 +87,14 @@
                       WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
                       COMMENT "Generating the manual website using Sphinx")
 
+    add_custom_command(
+      TARGET manual POST_BUILD
+      COMMAND ${CMAKE_COMMAND} -E copy_directory
+              ${CMAKE_BINARY_DIR}/doc/api/html
+              ${SPHINX_EXTRA_API}
+      COMMENT "Copying generated Doxygen HTML to Sphinx extra_html/api"
+    )
+    
     install(DIRECTORY ${SPHINX_BUILD}/
             DESTINATION share/codac_website
             OPTIONAL)

doc/manual/_static/css/custom.css

@@ -139,6 +139,10 @@ article .align-default {
   text-align: left;
 }
 
+article .align-centered {
+  text-align: center;
+}
+
 dl.cpp:not(dl.cpp dl.cpp) { /* for displaying a border on doxygen blocks */
   border-left: 5px solid var(--color-background-border);
   padding-left: 5px;
@@ -159,4 +163,17 @@ a .download:before {
 .toggle-hidden .sphinx-tabs-panel, .toggle-hidden [aria-selected="true"] {
   background-color: #AAFFBF;
   border-bottom: 1px solid #AAFFBF;
+}
+
+.reveal-bg { /* displays a checkerboard background to reveal transparency effects */
+  --size: 12px;
+
+  background-color: #eee;
+  background-image:
+      linear-gradient(45deg, #ddd 25%, transparent 25%),
+      linear-gradient(-45deg, #ddd 25%, transparent 25%),
+      linear-gradient(45deg, transparent 75%, #ddd 75%),
+      linear-gradient(-45deg, transparent 75%, #ddd 75%);
+  background-size: var(--size) var(--size);
+  background-position: 0 0, 0 calc(var(--size)/2), calc(var(--size)/2) calc(var(--size)/-2), calc(var(--size)/-2) 0;
 }

doc/manual/_static/logos/logo_codac.pdf

@@ -32,7 +32,8 @@ exclude_patterns = []
 
 html_static_path = ['_static']
 html_theme = "furo"
-html_logo = "_static/logos/logo_codac.svg"
+#html_logo = "_static/logos/logo_codac.svg"
+html_logo = "_static/logos/logo_codac_christmas.png"
 html_favicon = "_static/logos/logo_codac.ico"
 
 # These paths are either relative to html_static_path
@@ -105,4 +106,6 @@ breathe_projects = {
 
 #togglebutton_hint = "<strong style=\"color: #009945;\">Reveal the solution.</strong>"
 togglebutton_hint = "Reveal the solution."
-togglebutton_hint_hide = "Hide the solution."
+togglebutton_hint_hide = "Hide the solution."
+
+html_extra_path = ['extra_html']