Skip to content

Commit 38e45de

Browse files
mobius3mobius3
committed
updates docs to have favicon and logo
1 parent f757bbc commit 38e45de

File tree

6 files changed

+113
-11
lines changed

6 files changed

+113
-11
lines changed

‎doc/CMakeLists.txt‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ if(DOXYGEN_FOUND)
1111
set(DOXYGEN_TARGET_INDEX_HTML ${CMAKE_CURRENT_BINARY_DIR}/html/index.html)
1212
set(CSS_INPUT ${CMAKE_CURRENT_SOURCE_DIR}/doxygen-extra.css)
1313
set(CSS_OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/doxygen-extra.css)
14+
set(HEADER_HTML_INPUT ${CMAKE_CURRENT_SOURCE_DIR}/header.html)
15+
set(HEADER_HTML_OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/header.html)
16+
set(LOGO_INPUT ${CMAKE_CURRENT_SOURCE_DIR}/logo-blue.png)
17+
set(LOGO_OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/logo-blue.png)
1418
set(MANUAL_DOX_INPUT ${CMAKE_CURRENT_SOURCE_DIR}/manual.dox)
1519
set(MANUAL_DOX_OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/manual.dox)
1620
set(DOXYGENLAYOUT_INPUT ${CMAKE_CURRENT_SOURCE_DIR}/DoxygenLayout.xml)
@@ -22,6 +26,16 @@ if(DOXYGEN_FOUND)
2226
COMMAND ${CMAKE_COMMAND} -E copy ${CSS_INPUT} ${CSS_OUTPUT}
2327
DEPENDS ${CSS_INPUT}
2428
)
29+
add_custom_command(OUTPUT
30+
${HEADER_HTML_OUTPUT}
31+
COMMAND ${CMAKE_COMMAND} -E copy ${HEADER_HTML_INPUT} ${HEADER_HTML_OUTPUT}
32+
DEPENDS ${HEADER_HTML_INPUT}
33+
)
34+
add_custom_command(OUTPUT
35+
${LOGO_OUTPUT}
36+
COMMAND ${CMAKE_COMMAND} -E copy ${LOGO_INPUT} ${LOGO_OUTPUT}
37+
DEPENDS ${LOGO_INPUT}
38+
)
2539
add_custom_command(OUTPUT
2640
${MANUAL_DOX_OUTPUT}
2741
COMMAND ${CMAKE_COMMAND} -E copy ${MANUAL_DOX_INPUT} ${MANUAL_DOX_OUTPUT}
@@ -33,10 +47,17 @@ if(DOXYGEN_FOUND)
3347
DEPENDS ${DOXYGENLAYOUT_INPUT}
3448
)
3549
add_custom_command(OUTPUT ${DOXYGEN_TARGET_INDEX_HTML}
36-
DEPENDS ${FONT_CHEF_PUBLIC_HEADERS} ${CSS_OUTPUT} ${MANUAL_DOX_OUTPUT} ${DOXYGENLAYOUT_OUTPUT}
50+
DEPENDS
51+
${FONT_CHEF_PUBLIC_HEADERS}
52+
${CSS_OUTPUT}
53+
${MANUAL_DOX_OUTPUT}
54+
${DOXYGENLAYOUT_OUTPUT}
55+
${HEADER_HTML_OUTPUT}
56+
${LOGO_OUTPUT}
3757
MAIN_DEPENDENCY ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
3858
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
3959
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
60+
COMMAND ${CMAKE_COMMAND} -E copy ${LOGO_INPUT} ${CMAKE_CURRENT_BINARY_DIR}/html/
4061
COMMENT "Generating API documentation with Doxygen" VERBATIM
4162
)
4263
add_custom_target(doc ALL DEPENDS ${DOXYGEN_TARGET_INDEX_HTML})

‎doc/Doxyfile.in‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ PROJECT_BRIEF = "A font cooking library"
5151
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
5252
# the logo to the output directory.
5353

54-
PROJECT_LOGO =
54+
PROJECT_LOGO = logo-blue.png
5555

5656
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
5757
# into which the generated documentation will be written. If a relative path is
@@ -1207,7 +1207,7 @@ HTML_FILE_EXTENSION = .html
12071207
# of the possible markers and block names see the documentation.
12081208
# This tag requires that the tag GENERATE_HTML is set to YES.
12091209

1210-
HTML_HEADER =
1210+
HTML_HEADER = header.html
12111211

12121212
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
12131213
# generated HTML page. If the tag is left blank doxygen will generate a standard

‎doc/doxygen-extra.css‎

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
@import url('https://fonts.googleapis.com/css2?family=Nunito:ital,wght@0,200;0,400;0,600;0,800;1,200;1,400&display=swap');
22
@import url('https://fonts.googleapis.com/css2?family=Fira+Code:wght@300;400;500;600;700&display=swap');
3+
@import url('https://fonts.googleapis.com/css2?family=Overpass:ital,wght@0,400;0,600;0,700;1,400;1,600;1,700&display=swap');
4+
5+
:root {
6+
--main-font: 'Overpass'
7+
}
38

49
code {
510
font-family: 'Fira Code', monospace, fixed !important;
@@ -10,11 +15,12 @@ code {
1015
body {
1116
max-width: 960px;
1217
margin: 0 auto;
13-
font-family: Nunito, sans-serif;
18+
font-family: var(--main-font, 'cursive'), sans-serif;
1419
}
1520

1621
body, table, div, p, dl {
17-
font-family: Nunito, sans-serif !important;
22+
font-family: var(--main-font, 'cursive'), sans-serif !important;
23+
font-size: 15px;
1824
}
1925

2026
h1, h2 {
@@ -36,13 +42,21 @@ h2.groupheader {
3642
border-bottom: none;
3743
}
3844

45+
#top #titlearea > table, #top #titlearea > table > tbody {
46+
width: 100%;
47+
}
48+
3949
#projectalign {
4050
padding-left: 10px !important;
4151
}
4252

53+
#projectlogo {
54+
55+
}
56+
4357
#projectname {
44-
font-family: Nunito, sans-serif;
45-
font-weight: 800;
58+
width: 0;
59+
max-width: 0;
4660
}
4761

4862
#projectnumber {
@@ -52,8 +66,13 @@ h2.groupheader {
5266
top: 10px;
5367
right: 10px;
5468
border-radius: 10px;
55-
background-color: var(--color-fg-secondary);
5669
padding: 0 10px;
70+
font-family: var(--main-font, 'cursive'), sans-serif !important;
71+
color: #777;
72+
}
73+
74+
#projectnumber:before {
75+
content: 'v'
5776
}
5877

5978
#projectbrief {
@@ -123,7 +142,7 @@ h2.groupheader {
123142

124143
#main-menu #MSearchBox > .left, #main-menu #MSearchBox > .right, #main-menu #MSearchField {
125144
background: none;
126-
font-family: Nunito, sans-serif !important;
145+
font-family: var(--main-font, 'cursive'), sans-serif !important;
127146
font-weight: 600;
128147
padding-left: 5px;
129148
font-size: 14px;
@@ -154,7 +173,7 @@ div.directory {
154173
}
155174

156175
table.directory {
157-
font-family: Nunito, sans-serif !important;
176+
font-family: var(--main-font, 'cursive'), sans-serif !important;
158177
}
159178

160179
table.directory > tbody > tr {
@@ -186,7 +205,7 @@ hr.footer {
186205

187206
.mdescLeft, .mdescRight {
188207
background-color: transparent;
189-
font-family: Nunito, sans-serif;
208+
font-family: var(--main-font, 'cursive'), sans-serif;
190209
padding: 0 0;
191210
font-style: italic;
192211
}
@@ -268,3 +287,8 @@ hr {
268287
opacity: 0;
269288
padding: 20px 0;
270289
}
290+
291+
.sm-dox a, .sm-dox a:focus, .sm-dox a:hover, .sm-dox a:active {
292+
font-family: var(--main-font, 'cursive'), sans-serif !important;
293+
font-weight: 600 !important;
294+
}

‎doc/font-chef.png‎

10.2 KB
Loading

‎doc/header.html‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
<!-- HTML header for doxygen 1.8.17-->
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3+
<html xmlns="http://www.w3.org/1999/xhtml">
4+
<head>
5+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7+
<meta name="generator" content="Doxygen $doxygenversion"/>
8+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
9+
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
10+
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
11+
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
12+
<link rel="icon" type="image/png" href="$relpath^font-chef.png"/>
13+
<script type="text/javascript" src="$relpath^jquery.js"></script>
14+
<script type="text/javascript" src="$relpath^dynsections.js"></script>
15+
$treeview
16+
$search
17+
$mathjax
18+
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
19+
$extrastylesheet
20+
</head>
21+
<body>
22+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
23+
24+
<!--BEGIN TITLEAREA-->
25+
<div id="titlearea">
26+
<table cellspacing="0" cellpadding="0">
27+
<tbody>
28+
<tr style="height: 56px;">
29+
<!--BEGIN PROJECT_LOGO-->
30+
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
31+
<!--END PROJECT_LOGO-->
32+
<!--BEGIN PROJECT_NAME-->
33+
<td id="projectalign" style="padding-left: 0.5em;">
34+
<div id="projectname">
35+
<!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
36+
</div>
37+
<!--BEGIN PROJECT_BRIEF--><!--END PROJECT_BRIEF-->
38+
</td>
39+
<!--END PROJECT_NAME-->
40+
<!--BEGIN !PROJECT_NAME-->
41+
<!--BEGIN PROJECT_BRIEF-->
42+
<td style="padding-left: 0.5em;">
43+
<div id="projectbrief">$projectbrief</div>
44+
</td>
45+
<!--END PROJECT_BRIEF-->
46+
<!--END !PROJECT_NAME-->
47+
<!--BEGIN DISABLE_INDEX-->
48+
<!--BEGIN SEARCHENGINE-->
49+
<td>$searchbox</td>
50+
<!--END SEARCHENGINE-->
51+
<!--END DISABLE_INDEX-->
52+
</tr>
53+
</tbody>
54+
</table>
55+
</div>
56+
<!--END TITLEAREA-->
57+
<!-- end header part -->

‎doc/logo-blue.png‎

26.3 KB
Loading

0 commit comments

Comments
 (0)