Unverified Commit 49718b2c authored by SZPYRKA Jean-Luc's avatar SZPYRKA Jean-Luc
Browse files

dtk-* doc aggregation

parent f11c3f5a
image: conda/miniconda3-centos7
pages:
stage: deploy
script:
# conda environment setup for doc generation
- conda update -n base -c defaults conda
- conda env update -f pkg/env/dtk-doc.yaml -n dtk-doc
- conda init bash
- source ~/.bashrc
- conda activate dtk-doc
# documentation generation
- mkdir build && cd build
- cmake -DBUILD_DOC_ONLY=TRUE -DCMAKE_C_COMPILER=true -DCMAKE_CXX_COMPILER=true ..
- make
- make doc
- mv doc/website ../public
artifacts:
paths:
- public
only:
- feature/sphinx_doc
# - master
......@@ -12,11 +12,16 @@
##
### Code:
cmake_minimum_required(VERSION 3.9)
#
# no need fot compiler here
set(CMAKE_C_COMPILER true)
set(CMAKE_CXX_COMPILER true)
cmake_minimum_required(VERSION 3.12)
######################################################################
project(dtkDoc)
project(dtk2.0)
## ###################################################################
## Versionning
......@@ -29,41 +34,20 @@ set(${PROJECT_NAME}_VERSION
${${PROJECT_NAME}_VERSION_MAJOR}.${${PROJECT_NAME}_VERSION_MINOR}.${${PROJECT_NAME}_VERSION_PATCH})
## ###################################################################
## Dependencies
## ###################################################################
find_package(Qt5Core REQUIRED)
## ###################################################################
## Setup
## ###################################################################
get_target_property(QT5_QMAKE_EXECUTABLE Qt5::qmake LOCATION)
get_filename_component(QT5_BINARY_DIR ${QT5_QMAKE_EXECUTABLE} PATH)
## ###################################################################
## Config
## Input
## ###################################################################
string(SUBSTRING ${Qt5Core_VERSION_STRING} 0 3 Qt5_VERSION)
set(QT5_DOCUMENTATION_D "${QT5_BINARY_DIR}/../../../Docs/Qt-${Qt5Core_VERSION_STRING}")
set(QT5_QDOC_EXECUTABLE "${QT5_BINARY_DIR}/qdoc")
set(QT5_QHGN_EXECUTABLE "${QT5_BINARY_DIR}/qhelpgenerator")
#set( DTK_LOG_DIRECTORY ${CMAKE_SOURCE_DIR}/../dtk-log)
#set(DTK_WIDGETS_DIRECTORY ${CMAKE_SOURCE_DIR}/../dtk-widgets)
message(STATUS "Using Qt5 binary dir: ${QT5_BINARY_DIR}")
message(STATUS "Using Qt5 binary qdoc: ${QT5_QDOC_EXECUTABLE}")
message(STATUS "Using Qt5 binary qhgn: ${QT5_QHGN_EXECUTABLE}")
## ###################################################################
## Input
## ###################################################################
set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake")
include(git_clone)
set( DTK_LOG_DIRECTORY ${CMAKE_SOURCE_DIR}/../dtk-log)
set(DTK_WIDGETS_DIRECTORY ${CMAKE_SOURCE_DIR}/../dtk-widgets)
git_clone(dtk-core)
git_clone(dtk-log)
git_clone(dtk-widgets)
add_subdirectory(src)
add_subdirectory(doc)
######################################################################
### CMakeLists.txt ends here
#
#
#
include(ExternalProject)
macro(git_clone module)
ExternalProject_Add(${module}
GIT_REPOSITORY git@gitlab.inria.fr:dtk/${module}.git
BUILD_COMMAND ""
CMAKE_COMMAND ""
CONFIGURE_COMMAND ""
INSTALL_COMMAND ""
UPDATE_COMMAND ""
PATCH_COMMAND ""
)
endmacro()
# configured documentation tools and intermediate build results
set(BINARY_BUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}/_build")
find_package(Doxygen REQUIRED)
find_program(SPHINX_EXECUTABLE sphinx-build)
if(NOT SPHINX_EXECUTABLE)
message(FATAL_ERROR "sphinx-build not found! Aborting...")
endif()
add_custom_target(doc-website-files
WORKING_DIRECTORY ${BINARY_BUILD_DIR}
COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/source ${BINARY_BUILD_DIR}/source
COMMENT "Making build copy of website source files"
)
add_custom_target(doc-website
WORKING_DIRECTORY ${BINARY_BUILD_DIR}
COMMAND ${SPHINX_EXECUTABLE} ${BINARY_BUILD_DIR}/source ${CMAKE_CURRENT_BINARY_DIR}/website
DEPENDS doc-website-files
COMMENT "Building web site with ${SPHINX_EXECUTABLE}"
)
add_custom_target(doc
WORKING_DIRECTORY ${BINARY_BUILD_DIR}
COMMAND ${DOXYGEN_EXECUTABLE} ${BINARY_BUILD_DIR}/Doxyfile
DEPENDS doc-website
COMMENT "Building Doxygen doc")
configure_file(Doxyfile.in
${BINARY_BUILD_DIR}/Doxyfile
IMMEDIATE @ONLY)
configure_file(css/custom.css
${BINARY_BUILD_DIR}/css/custom.css
IMMEDIATE @ONLY)
configure_file(source/conf.py.in
${BINARY_BUILD_DIR}/source/conf.py
IMMEDIATE @ONLY)
This diff is collapsed.
/* from https://github.com/aklapatch/doxygenTheme/blob/master/CustomDoxygen.css */
/* function descriptions */
.memtitle {
padding: 8px;
border-top: 1px solid #999;
border-left: 1px solid #999;
border-right: 1px solid #999;
border-top-right-radius: 4px;
border-top-left-radius: 4px;
margin-bottom: -1px;
background-image: url();
background-repeat: repeat-x;
background-color: #fff;
line-height: 1.25;
font-weight: 600;
float: left;
}
dt {
font-weight: 600;
}
p.reference, p.definition {
font: 400 14px/22px -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol;;
margin-top: 0px;
margin-bottom: 5px;
padding-top: 8px;
border-top: 1px solid #eee;
}
/* parameter names */
.params .paramname, .retval .paramname, .tparams .paramname {
font-weight: 600;
vertical-align: top;
}
/* parameter data types */
.paramtype {
white-space: nowrap;
color: #008141;
}
/* headers */
h1, h2, h3, h4, h5, h6 {
font-weight: 600;
}
/* parameter names */
.paramname {
color: #db0303;
white-space: nowrap;
}
/* overall style */
body, table, div, p, dl {
font-style: normal;
font-variant-ligatures: normal;
font-variant-caps: normal;
font-variant-numeric: normal;
font-variant-east-asian: normal;
font-weight: 500;
font-stretch: normal;
font-size: 14px;
line-height: 22px;
font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol;
}
/* project name */
#projectname {
/* markdown font */
font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol;
font-weight: 600;
margin: 0;
padding: 2px 0;
}
/* title area */
#titlearea {
padding: 0;
margin: 0;
width: 100%;
border-bottom: none;
}
h2.groupheader {
border-bottom: 1px solid #eee;
color: #000;
font-size: 150%;
font-weight: 600;
font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol;
margin-top: 1em;
padding-top: 12px;
padding-bottom: 4px;
width: 100%;
}
/* function description text box */
.memdoc, dl.reflist dd {
border-bottom: none;
border-left: none;
border-right: none;
padding: 0px 10px 0px 10px;
background-color: #FFF;
border-top-width: 0;
background-image: none;
background-repeat: repeat-x;
border-bottom-left-radius: 4px;
border-bottom-right-radius: 4px;
box-shadow: 5px 5px 5px rgba(0, 0, 0, 0);
-moz-border-radius-bottomleft: 4px;
-moz-border-radius-bottomright: 4px;
-moz-box-shadow: rgba(0, 0, 0, 0) 5px 5px 5px;
-webkit-border-bottom-left-radius: 4px;
-webkit-border-bottom-right-radius: 4px;
-webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0);
}
/* function prototype text box */
.memproto, dl.reflist dt {
border-bottom: 1px solid #999;
border-top: 1px solid #999;
border-left: 1px solid #999;
border-right: 1px solid #999;
padding: 0px 0 0px 0;
color: #000;
font-weight: bold;
text-shadow: none;
background-color: #f9f9f9;
box-shadow: none;
border-top-right-radius: 4px;
-moz-box-shadow: none;
-moz-border-radius-topright: 4px;
-webkit-box-shadow: none;
-webkit-border-top-right-radius: 4px;
}
/* function prototype */
.memname td {
vertical-align: bottom;
font-family: "Lucida Grande", "Geneva", "Helvetica", Arial, sans-serif;
}
/* icon for each data type */
.icon {
background-color: #026ea1;
}
/* arrows for treenav */
.arrow {
color: #09A716;
-webkit-user-select: none;
-khtml-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;
cursor: pointer;
font-size: 80%;
display: inline-block;
width: 16px;
height: 22px;
}
/* colors and fonts for description pages */
table, div, p, dl {
font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol;
font-weight: normal;
color: black;
}
.sm li, .sm a {
position: relative;
color: black;
}
body {
font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol;
font-weight: normal;
color: #FFF;
min-height: 100%;
overflow-x: hidden;
background: #fff;
}
/* file member function descriptions */
.memberdecls td, .fieldtable tr {
-webkit-transition-property: background-color, box-shadow;
-webkit-transition-duration: 0.5s;
-moz-transition-property: background-color, box-shadow;
-moz-transition-duration: 0.5s;
-ms-transition-property: background-color, box-shadow;
-ms-transition-duration: 0.5s;
-o-transition-property: background-color, box-shadow;
-o-transition-duration: 0.5s;
transition-property: background-color, box-shadow;
transition-duration: 0.5s;
font-family: "Lucida Grande", "Geneva", "Helvetica", Arial, sans-serif;
font-weight: 501;
}
/* function descriptor */
td.mdescLeft, td.mdescRight {
padding: 0 8px 4px 8px;
color: #000;
font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol;
font-weight: 400;
}
/* headers for #include descriptions */
tt, code, kbd, samp {
display: inline-block;
direction: ltr;
background-color: #f8f8f8;
font-family: SFMono-Regular,Consolas,Liberation Mono,Menlo,Courier,monospace;
font-weight: 550;
}
/* list for file members */
div.contents {
font-family: "Lucida Grande", "Geneva", "Helvetica", Arial, sans-serif;
font-weight: 550;
}
/* links to a class or struct on the class list page */
a.el {
font-family: "Lucida Grande", "Geneva", "Helvetica", Arial, sans-serif;
font-weight: 550;
}
/* header dividers */
hr {
height: 0;
border: none;
border-top: 1px solid #eee;
}
#side-nav {
padding: 0 0 0 0;
margin: 0;
display: block;
position: absolute;
left: 0;
width: 250;
}
/* nav tree arrow symbol */
#nav-sync img {
opacity: 0;
}
#nav-sync img:hover {
opacity: 0.9;
}
/* The main page button */
.sm-dox>li:first-child>a, .sm-dox>li:first-child> :not(ul) a {
padding-right: 12px;
}
/* content of for all class members list */
#doc-content {
overflow: auto;
display: block;
padding: 0;
margin: 0;
margin-left: 0;
-webkit-overflow-scrolling: touch;
background-color: #FFF;
}
/* label for which tree menu you are on (displays in the doc menu */
.title {
font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol;
font-weight: 600;
font-size: 150%;
margin: -2px 0 0 2px;
background-color: white;
}
/* title for each section (class List, Class index) */
#titlearea {
padding: 0;
margin: 0;
width: 100%;
border-bottom: none;
}
/* title for each section (class List, Class index) */
div.headertitle {
padding: none;
background-color: white;
}
/* actual header for each section */
div.header {
background-image: none;
background-repeat: repeat-x;
background-color: #FFF;
margin: 0;
border-bottom: 1px solid #eee;
}
/* for class and function lists */
table.directory {
font-style: normal;
font-variant-caps: normal;
font-weight: normal;
font-stretch: normal;
line-height: normal;
font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol;
font-size-adjust: none;
font-kerning: auto;
font-optical-sizing: auto;
font-variant-alternates: normal;
font-variant-east-asian: normal;
font-variant-ligatures: normal;
font-variant-numeric: normal;
font-variant-position: normal;
font-language-override: normal;
font-feature-settings: normal;
font-variation-settings: normal;
}
/* main page, classes, files banner */
.sm-dox {
padding: 0 0;
background-image: none;
line-height: 36px;
background-color: #2980B9;
}
/* item list on botton left */
.navpath li.navelem a {
height: 32px;
display: block;
text-decoration: none;
outline: none;
color: #FFF;
font-family: 'Lucida Grande', Geneva, Helvetica, Arial, sans-serif;
text-shadow: none;
text-decoration: none;
}
.navpath li {
list-style-type: none;
float: left;
padding-left: 10px;
padding-right: 15px;
background-image: none;
background-repeat: no-repeat;
background-position: right;
color: #364D7C;
}
/* top menu, Classes button */
.sm-dox a, .sm-dox a:focus, .sm-dox a:active, .sm-dox a.highlighted, .sm-dox a.highlighted {
padding-right: 12px;
background-image: none;
background-repeat: no-repeat;
background-position: right;
background-color: #2980B9;
color: #b8b8b8;
padding-left: 12px;
}
.sm-dox a.has-submenu {
padding-right: 24px;
}
.sm a {
display: block;
}
/* top menu, main buttons label */
.sm-dox a, .sm-dox a:focus, .sm-dox a:visited, .sm-dox a:visited {
font-family: "Lucida Grande", "Geneva", "Helvetica", Arial, sans-serif;
font-size: 14px;
font-weight: bold;
line-height: 36px;
color: #000;
text-shadow: none;
}
/* hover over class/main page, files buttons */
.sm-dox a:hover {
font-family: "Lucida Grande", "Geneva", "Helvetica", Arial, sans-serif;
font-size: 14px;
font-weight: bold;
line-height: 36px;
text-decoration: none;
text-decoration-line: none;
text-decoration-style: solid;
text-decoration-color: currentcolor;
text-shadow: none;
color: #FFF;
outline: 0;
outline-color: currentcolor;
outline-style: none;
outline-width: 0;
background-color: #156ac9;
background-image: none;
}
.sm-dox ul a:hover {
background-image: none;
background-repeat: repeat-x;
color: white;
background-color: #000;
text-shadow: none;
}
/* top list items */
.sm-dox ul {
color: #FFF;
border-top-color: rgb(187, 187, 187);
border-top-style: solid;
border-top-width: 1px;
border-right-color: rgb(187, 187, 187);
border-right-style: solid;
border-right-width: 1px;
border-bottom-color: rgb(187, 187, 187);
border-bottom-style: solid;
border-bottom-width: 1px;
border-left-color: rgb(187, 187, 187);
border-left-style: solid;
border-left-width: 1px;
border-image-outset: 0;
border-image-repeat: stretch;
border-image-slice: 100%;
border-image-source: none;
border-image-width: 1;
padding: 5px 0;
background: #fff;
background-color: rgb(255, 255, 255);
background-position-x: 0%;
background-position-y: 0%;
background-repeat: repeat;
background-attachment: scroll;
background-image: none;
background-size: auto;
background-origin: padding-box;
background-clip: border-box;
-moz-border-radius: 5px !important;
-webkit-border-radius: 5px;
border-radius: 5px !important;
-moz-box-shadow: 0 5px 9px rgba(0, 0, 0, 0.2);
-webkit-box-shadow: 0 5px 9px rgba(0, 0, 0, 0.2);
box-shadow: 0 5px 9px rgba(0, 0, 0, 0.2);
}
.sm-dox ul a:hover {
background-image: none;
}
/* dividers for class/function lists */
div.directory {
margin: 10px 0;
border-top: 1px solid #eee;
border-bottom: 1px solid #eee;
width: 100%;
}
/* for navigation tree links */
#nav-tree .label a {
padding-top: 1px;
padding-right: 1px;
padding-bottom: 1px;
margin-left: 12px;
color: #FFF;