From 3ffae9f7b7324843159a183f6808d35c0c7d2bee Mon Sep 17 00:00:00 2001 From: Maksim Shabunin Date: Fri, 26 Dec 2014 17:30:33 +0300 Subject: [PATCH] Some documentation customization --- doc/CMakeLists.txt | 13 +++++++---- doc/Doxyfile.in | 8 +++---- doc/bodybg.png | Bin 0 -> 513 bytes doc/footer.html | 21 +++++++++++++++++ doc/header.html | 56 +++++++++++++++++++++++++++++++++++++++++++++ doc/stylesheet.css | 33 ++++++++++++++++++++++++++ 6 files changed, 122 insertions(+), 9 deletions(-) create mode 100644 doc/bodybg.png create mode 100644 doc/footer.html create mode 100644 doc/header.html create mode 100644 doc/stylesheet.css diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 62ed98f02..b0ac11fcd 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -129,6 +129,14 @@ if(BUILD_DOCS AND DOXYGEN_FOUND) set(CMAKE_DOXYGEN_MAIN_REFERENCE "${refs_main}") set(CMAKE_DOXYGEN_EXTRA_REFERENCE "${refs_extra}") set(CMAKE_EXTRA_BIB_FILES "${bibfile} ${paths_bib}") + + list(APPEND CMAKE_DOXYGEN_HTML_FILES "${CMAKE_CURRENT_SOURCE_DIR}/opencv.ico") + list(APPEND CMAKE_DOXYGEN_HTML_FILES "${CMAKE_CURRENT_SOURCE_DIR}/pattern.png") + list(APPEND CMAKE_DOXYGEN_HTML_FILES "${CMAKE_CURRENT_SOURCE_DIR}/acircles_pattern.png") + list(APPEND CMAKE_DOXYGEN_HTML_FILES "${CMAKE_CURRENT_SOURCE_DIR}/bodybg.png") + list(APPEND CMAKE_DOXYGEN_HTML_FILES "${CMAKE_CURRENT_SOURCE_DIR}/mymath.sty") + string(REPLACE ";" " \\\n" CMAKE_DOXYGEN_HTML_FILES "${CMAKE_DOXYGEN_HTML_FILES}") + if(PLANTUML_JAR) set(CMAKE_DOXYGEN_PLANTUML_SUPPORT "PLANTUML_JAR_PATH = ${PLANTUML_JAR}\n") else() @@ -138,13 +146,8 @@ if(BUILD_DOCS AND DOXYGEN_FOUND) # writing file configure_file(Doxyfile.in ${doxyfile} @ONLY) configure_file(root.markdown.in ${rootfile} @ONLY) - configure_file(mymath.sty "${CMAKE_DOXYGEN_OUTPUT_PATH}/html/mymath.sty" @ONLY) - configure_file(mymath.sty "${CMAKE_DOXYGEN_OUTPUT_PATH}/latex/mymath.sty" @ONLY) - # TODO: do not store downloadable samples, but give github link instead add_custom_target(doxygen - COMMAND "${CMAKE_COMMAND}" -E copy "${CMAKE_CURRENT_SOURCE_DIR}/pattern.png" "${CMAKE_DOXYGEN_OUTPUT_PATH}/html" - COMMAND "${CMAKE_COMMAND}" -E copy "${CMAKE_CURRENT_SOURCE_DIR}/acircles_pattern.png" "${CMAKE_DOXYGEN_OUTPUT_PATH}/html" COMMAND ${DOXYGEN_EXECUTABLE} ${doxyfile} DEPENDS ${doxyfile} ${rootfile} ${bibfile} ${deps} ) diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 24ef50c41..05cc2735b 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -125,11 +125,11 @@ IGNORE_PREFIX = GENERATE_HTML = YES HTML_OUTPUT = html HTML_FILE_EXTENSION = .html -HTML_HEADER = -HTML_FOOTER = +HTML_HEADER = @CMAKE_CURRENT_SOURCE_DIR@/header.html +HTML_FOOTER = @CMAKE_CURRENT_SOURCE_DIR@/footer.html HTML_STYLESHEET = -HTML_EXTRA_STYLESHEET = -HTML_EXTRA_FILES = +HTML_EXTRA_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/stylesheet.css +HTML_EXTRA_FILES = @CMAKE_DOXYGEN_HTML_FILES@ HTML_COLORSTYLE_HUE = 220 HTML_COLORSTYLE_SAT = 100 HTML_COLORSTYLE_GAMMA = 80 diff --git a/doc/bodybg.png b/doc/bodybg.png new file mode 100644 index 0000000000000000000000000000000000000000..ebe92f66911ffc6a22a84b11ee8ad62b4b59cb03 GIT binary patch literal 513 zcmeAS@N?(olHy`uVBq!ia0vp^A|TAc3?z4jzqJQaoCO|{#X$M%Ak65bF}ngN$X?>< z>&kwYQIMURA&{#$6euK{84^+AoS&PUnpXnkGB7w7r6!i7rYMwWmSiZnd-?{X=%um) z#WMqZLR^3Rc=zMS`=397=)=#SAAkP*^z-NEU%x*6`UNDv{QC9v_wO&ie*?*Hzkh%K z{rktCKi~fR`Tpk*kn!`+pI?9f{`mVBNdEr&_s_q7zyAIE{qG-;@%JAH{Qv*|&;S2_ z|NjTEmVOj@z`(%BY@#4Be3OsBNk{sLmtgK~rE$Z9%-&ro=N_X+s_9dD7 z#T@o$O7i-JZZ`h0;uMEn$C``PlfDc6DHKfPpKbB_`L2ye6{0O8m+*$H+35M2*Hep*$&tKAhf4(ShD(f+e44U=WqR7jp>0{`8UA3z@jNzeX7d*C3e&n~Q zQr-86`7+J8sF>S}kFtd7e0zCkS@*RD_Eih=O=g7Tv$f4-Su$a|z@a(D?TX9hBy&tT z$g250<8G)I*E#*58>W}ODQ|7A@i>0TBV*;YHybD3@~F^R{_xD}d&QB_=NskbZjpcD wZZua#{u1N9@Sp^>tm>NPsxNor|L=dyzt~PHh}m4}3Mg(oUHx3vIVCg!06iH8I{*Lx literal 0 HcmV?d00001 diff --git a/doc/footer.html b/doc/footer.html new file mode 100644 index 000000000..e9a2ed7d9 --- /dev/null +++ b/doc/footer.html @@ -0,0 +1,21 @@ + + + + + + +
+$generatedby   +doxygen + $doxygenversion +
+ + + diff --git a/doc/header.html b/doc/header.html new file mode 100644 index 000000000..55f2ea171 --- /dev/null +++ b/doc/header.html @@ -0,0 +1,56 @@ + + + + + + + +$projectname: $title +$title + + + + +$treeview +$search +$mathjax + +$extrastylesheet + + +
+ + +
+ + + + + + + + + + + + + + + + + + + + + +
+
$projectname +  $projectnumber +
+
$projectbrief
+ 		+
$projectbrief
+ 		$searchbox
+
+ + diff --git a/doc/stylesheet.css b/doc/stylesheet.css new file mode 100644 index 000000000..7e827eeba --- /dev/null +++ b/doc/stylesheet.css @@ -0,0 +1,33 @@ +/* The standard CSS for doxygen 1.8.6 */ + +body, table, div, p, dl { + font: 400 14px/22px Helvetica, 'Segoe UI', Arial, freesans, sans-serif; + word-wrap: break-word; +} + +code { + font: 12px Consolas, "Liberation Mono", Courier, monospace; + font-size: 85%; + white-space: pre-wrap; + padding: 1px 5px; + padding: 0; + background-color: #ddd; + vertical-align: baseline; +} + +body { + background-image: url(bodybg.png); + margin: 0 auto; +} + +div.contents { + width: 980px; + margin: 0 auto; + padding: 15px 15px; + border: 1px solid rgb(10, 80, 122); + background-color: #fff; +} + +span.arrow { + height: 13px; +}