nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

refactor doc style

Browse source
This commit is contained in:
Johann Dreo 2022-01-27 13:11:20 +01:00
commit 132eb4f50e
10 changed files with 106 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

14
.gitignore vendored
View file

@ -1,11 +1,20 @@
# ignore html files
# ignore generated files
*.html
*.pdf
# ignore all textual files
*.txt
*.swp
*.swo
.kak_history
*.log
*.csv
*.ods
# ignore object and archive files
*.[oa]
*.bak
*.tar*
tags
# ignore auto-saved files
@ -29,4 +38,7 @@ debug/*
build/*
website/EO_star.png
website/paradiseo_logo.png
Release/*
Debug/*
Build/*

11
CMakeLists.txt
View file

@ -81,33 +81,34 @@ set(SMP "false" CACHE BOOL "Build the SMP module")
set(MPI "false" CACHE BOOL "Build the MPI module")
## EO Module
set(MODULE_NAME "Paradiseo")
set(DOXYGEN_CONFIG_DIR ${CMAKE_SOURCE_DIR}/doxygen)
# set(EO_MODULE_NAME "Evolving Objects")
set(MODULE_NAME "Evolving Objects")
set(CMAKE_SOURCE_DIR ${EO_SRC_DIR})
add_subdirectory(${EO_SRC_DIR})
if(NOT EO_ONLY)
## MO Module
# set(MO_MODULE_NAME "Moving Objects")
set(MODULE_NAME "Moving Objects")
# set(MODULE_NAME "Moving Objects")
set(CMAKE_SOURCE_DIR ${MO_SRC_DIR})
add_subdirectory(${MO_SRC_DIR})
## EDO Module
if(EDO)
set(EDO_MODULE_NAME "Evolving Distribution Objects")
# set(EDO_MODULE_NAME "Evolving Distribution Objects")
set(CMAKE_SOURCE_DIR ${EDO_SRC_DIR})
add_subdirectory(${EDO_SRC_DIR})
endif()
## MOEO Module
set(MOEO_MODULE_NAME "Multi-Objectives EO")
# set(MOEO_MODULE_NAME "Multi-Objectives EO")
set(CMAKE_SOURCE_DIR ${MOEO_SRC_DIR})
add_subdirectory(${MOEO_SRC_DIR})
## SMP Module
if(SMP)
set(SMP_MODULE_NAME "Symmetric Multi-Processing")
# set(SMP_MODULE_NAME "Symmetric Multi-Processing")
set(CMAKE_SOURCE_DIR ${SMP_SRC_DIR})
add_subdirectory(${SMP_SRC_DIR})
endif()

0
DoxygenLayout.xml → doxygen/DoxygenLayout.xml
View file

14
doxyfile.cmake → doxygen/doxyfile.cmake
View file

@ -27,6 +27,14 @@ DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = @MODULE_NAME@
# With the PROJECT_LOGO tag one can specify a logo or an icon
# that is included in the documentation.
# The maximum height of the logo should not exceed 55 pixels
# and the maximum width should not exceed 200 pixels.
# Doxygen will copy the logo to the output directory.
PROJECT_LOGO = @CMAKE_SOURCE_DIR@/docs/img/paradiseo_logo.svg
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
# if some version control system is used.
@ -484,7 +492,7 @@ FILE_VERSION_FILTER =
# file name after the option, if omitted DoxygenLayout.xml will be used as the name
# of the layout file.
LAYOUT_FILE = @CMAKE_SOURCE_DIR@/DoxygenLayout.xml
LAYOUT_FILE = @CMAKE_SOURCE_DIR@/doxygen/DoxygenLayout.xml
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
@ -775,9 +783,7 @@ HTML_FOOTER =
# the style sheet file to the HTML output directory, so don't put your own
# stylesheet in the HTML output directory as well, or it will be erased!
# HTML_EXTRA_STYLESHEET = @CMAKE_SOURCE_DIR@/doxygen-awesome-css/doxygen-awesome.css
# HTML_EXTRA_STYLESHEET = @CMAKE_SOURCE_DIR@/doxygen_theme_flat_design/src/doxygen-style.css
HTML_EXTRA_STYLESHEET = @CMAKE_SOURCE_DIR@/doxygen-style.css
HTML_EXTRA_STYLESHEET = @CMAKE_SOURCE_DIR@/doxygen/doxygen-style.css
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML

89
doxygen-style.css → doxygen/doxygen-style.css
View file

@ -8,9 +8,10 @@
--bgfont: #303030;
--bgfont2: #3771c8;
--bgfont-hover: #3771c8;
--bgfont-hover-text-decoration: none;
--bgfont-hover-text-decoration: underline solid #3771c8;
--bgborder: #7d7d7d;
--bgborder2: #f6f6f6;
--bgfont-link:#1751a8;
/* Main Header */
--bg1color: #303030;
--bg1font: #ffffff;
@ -26,15 +27,16 @@
--bg3font: #303030;
--bg3font2: #7D7D7D;
/* Code */
--code-bg: #f6f6f6;
--code-comment: #7D7D7D;
--code-keyword: #d73a49;
--code-preprocessor: #d73a49;
--code-keywordtype: #d73a49;
--code-text: #303030;
--code-code: #6f42c1;
--code-line: #7D7D7D;
--code-line-bg: #D8D8D8;
--code-bg: #232323;
--code-comment: #a5c261;
--code-keyword: #db4939;
--code-preprocessor: #efcd45;
--code-keywordtype: #87bbff;
--code-text: #b1cfb1;
--code-code: #d3d0cc;
--code-line: #73707c;
--code-line-bg: #232323;
--code-link: #b7dbff;
/* Namespace List, Class List icon */
--icon-bg: #303030
--icon-font: #3771c8;
@ -105,6 +107,7 @@ div.contents ul {
#projectalign {
padding: 0px !important;
vertical-align: bottom;
}
/***********************************/
@ -245,13 +248,24 @@ div.summary {
/***********************************/
a, a:visited, a:active, .contents a:visited, body.SRPage a, body.SRPage a:visited, body.SRPage a:active {
color: var(--bgfont);
color: var(--bgfont-link);
text-decoration: none;
}
a:hover, .contents a:hover, body.SRPage a:hover {
color: var(--bgfont-hover);
text-decoration: var(--bgfont-hover-text-decoration);
}
.dynheader {
color: var(--bgfont-link);
text-decoration: none;
}
.dynheader:hover {
color: var(--bgfont-hover);
text-decoration: var(--bgfont-hover-text-decoration);
}
/***********************************/
@ -341,11 +355,11 @@ li.navelem a {
}
.memdoc p, .memdoc dt {
padding: 0px 20px;
/*padding: 0px 20px;*/
}
.memdoc > p {
font-size:1.2em;
font-size:1em;
}
.paramname {
@ -462,13 +476,33 @@ h3 {
margin-bottom:2em;
border: 2px solid var(--bgfont2);
box-shadow:0.5em 0.5em 0.5em var(--bgfont);
font-family:monospace;
}
div.fragment, pre.fragment {
border: none;
padding: 20px;
margin: none;
padding: 1em;
margin-left: 1em;
margin-right: 1em;
background-color: var(--code-bg);
border-left: 2px solid black;
border-top: 2px solid black;
border-right: 2px solid grey;
border-bottom: 2px solid grey;
}
div.fragment > div.line {
font-size:1em;
line-height:150%;
color: var(--code-code);
}
.textblock > div.fragment {
font-size: 1em;
}
.textblock > dl.section {
font-size: 1.2em;
}
div.line {
@ -491,6 +525,10 @@ span.keywordtype {
color: var(--code-keywordtype);
}
span.stringliteral {
color: var(--code-text);
}
span.mlabel {
background-color: var(--code-text);
color: var(--code-bg);
@ -502,8 +540,8 @@ span.mlabel {
border-radius: 0px;
}
a.code {
color: var(--code-code);
div.fragment > div.line > a.code {
color: var(--code-link);
}
span.lineno, span.lineno>* {
@ -521,6 +559,10 @@ span.lineno a:hover {
background-color: var(--code-line-bg);
}
code {
color:black;
}
/***********************************/
/************* directory ***********/
@ -605,6 +647,19 @@ table.classindex a.el {
font-weight: normal;
}
table.params {
margin-top:1em;
}
#titlearea > table {
margin-top:0px;
}
table.directory > tbody > tr {
border-top: thin solid var(--nav-tree-bg);
border-bottom: thin solid var(--nav-tree-bg);
}
/***********************************/
/************** footer *************/

2
edo/doc/CMakeLists.txt
View file

@ -23,7 +23,7 @@ if(DOXYGEN_FOUND)
endif(UNIX AND NOT ${CMAKE_VERBOSE_MAKEFILE})
endif(DOXYGEN_EXECUTABLE)
# configure_file("${CMAKE_CURRENT_SOURCE_DIR}/${EDO_DOC_CONFIG_FILE}.cmake"
configure_file("${CMAKE_SOURCE_DIR}/doxyfile.cmake"
configure_file("${DOXYGEN_CONFIG_DIR}/doxyfile.cmake"
"${EDO_DOC_DIR}/${EDO_DOC_CONFIG_FILE}")
install(
DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}

2
eo/doc/CMakeLists.txt
View file

@ -34,7 +34,7 @@ IF (DOXYGEN_FOUND)
# configure cfg file
# "${CMAKE_CURRENT_SOURCE_DIR}/${EO_DOC_CONFIG_FILE}.cmake"
CONFIGURE_FILE(
"${CMAKE_SOURCE_DIR}/doxyfile.cmake"
"${DOXYGEN_CONFIG_DIR}/doxyfile.cmake"
"${CMAKE_CURRENT_BINARY_DIR}/${EO_DOC_CONFIG_FILE}"
)

2
mo/doc/CMakeLists.txt
View file

@ -20,7 +20,7 @@ if(DOXYGEN_FOUND)
endif(UNIX AND NOT ${CMAKE_VERBOSE_MAKEFILE})
endif(DOXYGEN_EXECUTABLE)
# configure_file("${CMAKE_CURRENT_SOURCE_DIR}/${MO_DOC_CONFIG_FILE}.cmake"
configure_file("${CMAKE_SOURCE_DIR}/doxyfile.cmake"
configure_file("${DOXYGEN_CONFIG_DIR}/doxyfile.cmake"
"${MO_DOC_DIR}/${MO_DOC_CONFIG_FILE}")
install(
DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}

2
moeo/doc/CMakeLists.txt
View file

@ -23,7 +23,7 @@ if(DOXYGEN_FOUND)
endif(UNIX AND NOT ${CMAKE_VERBOSE_MAKEFILE})
endif(DOXYGEN_EXECUTABLE)
# configure_file("${CMAKE_CURRENT_SOURCE_DIR}/${MOEO_DOC_CONFIG_FILE}.cmake"
configure_file("${CMAKE_SOURCE_DIR}/doxyfile.cmake"
configure_file("${DOXYGEN_CONFIG_DIR}/doxyfile.cmake"
"${MOEO_DOC_DIR}/${MOEO_DOC_CONFIG_FILE}")
install(
DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}

2
smp/doc/CMakeLists.txt
View file

@ -20,7 +20,7 @@ if(DOXYGEN_FOUND)
endif(UNIX AND NOT ${CMAKE_VERBOSE_MAKEFILE})
endif(DOXYGEN_EXECUTABLE)
# configure_file("${CMAKE_CURRENT_SOURCE_DIR}/${SMP_DOC_CONFIG_FILE}.cmake"
configure_file("${CMAKE_SOURCE_DIR}/doxyfile.cmake"
configure_file("${DOXYGEN_CONFIG_DIR}/doxyfile.cmake"
"${SMP_DOC_DIR}/${SMP_DOC_CONFIG_FILE}")
install(
DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}