Skip to content

Commit 91670c9

Browse files
henryleberrehenryleberre
committed
Fix & Add favicon to docs
1 parent fb8b159 commit 91670c9

File tree

5 files changed

+94
-20
lines changed

5 files changed

+94
-20
lines changed

‎CMakeLists.txt‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -315,26 +315,26 @@ macro(GEN_DOCS target name)
315315
set(DOXYGEN_PROJECT_NAME "${name}")
316316
set(DOXYGEN_INPUT "${CMAKE_CURRENT_SOURCE_DIR}/src/${target}/ ${CMAKE_CURRENT_BINARY_DIR}/doxygen/${target}/")
317317

318-
file(
319-
COPY "${CMAKE_CURRENT_SOURCE_DIR}/doc/${target}"
320-
DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/doxygen"
321-
)
318+
file(COPY "${CMAKE_CURRENT_SOURCE_DIR}/doc/${target}"
319+
DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/doxygen")
320+
321+
file(COPY "${CMAKE_CURRENT_SOURCE_DIR}/doc/header.html"
322+
DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/doxygen/${target}")
323+
324+
file(COPY "${CMAKE_CURRENT_SOURCE_DIR}/doc/footer.html"
325+
DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/doxygen/${target}")
322326

323327
configure_file(
324328
"${CMAKE_CURRENT_SOURCE_DIR}/doc/Doxyfile.in"
325329
"${CMAKE_CURRENT_BINARY_DIR}/doxygen/${target}/Doxyfile"
326330
@ONLY
327331
)
328332

329-
file(
330-
COPY "${CMAKE_CURRENT_SOURCE_DIR}/doc/res"
331-
DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/doxygen"
332-
)
333+
file(COPY "${CMAKE_CURRENT_SOURCE_DIR}/doc/res"
334+
DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/doxygen")
333335

334-
file(
335-
COPY "${CMAKE_CURRENT_SOURCE_DIR}/doc/config.js"
336-
DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/doxygen"
337-
)
336+
file(COPY "${CMAKE_CURRENT_SOURCE_DIR}/doc/config.js"
337+
DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/doxygen")
338338

339339
add_custom_command(
340340
OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/doxygen/${target}/html/index.html"

‎doc/Doxyfile.in‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ PROJECT_NAME = "@DOXYGEN_PROJECT_NAME@"
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

41-
PROJECT_NUMBER = 4.0.0
41+
PROJECT_NUMBER =
4242

4343
# Using the PROJECT_BRIEF tag one can provide an optional one line description
4444
# for a project that appears at the top of each page and should give viewer a
@@ -1166,7 +1166,7 @@ HTML_FILE_EXTENSION = .html
11661166
# of the possible markers and block names see the documentation.
11671167
# This tag requires that the tag GENERATE_HTML is set to YES.
11681168

1169-
HTML_HEADER =
1169+
HTML_HEADER = header.html
11701170

11711171
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
11721172
# generated HTML page. If the tag is left blank doxygen will generate a standard
@@ -1176,7 +1176,7 @@ HTML_HEADER =
11761176
# that doxygen normally uses.
11771177
# This tag requires that the tag GENERATE_HTML is set to YES.
11781178

1179-
HTML_FOOTER =
1179+
HTML_FOOTER = footer.html
11801180

11811181
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
11821182
# sheet that is used by each HTML page. It can be used to fine-tune the look of
@@ -1188,7 +1188,7 @@ HTML_FOOTER =
11881188
# obsolete.
11891189
# This tag requires that the tag GENERATE_HTML is set to YES.
11901190

1191-
HTML_STYLESHEET =
1191+
HTML_STYLESHEET = style.css
11921192

11931193
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
11941194
# cascading style sheets that are included after the standard style sheets
@@ -1211,7 +1211,7 @@ HTML_EXTRA_STYLESHEET = @DOXYGEN_HTML_EXTRA_STYLESHEET@
12111211
# files will be copied as-is; there are no commands or markers available.
12121212
# This tag requires that the tag GENERATE_HTML is set to YES.
12131213

1214-
HTML_EXTRA_FILES =
1214+
HTML_EXTRA_FILES =
12151215

12161216
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
12171217
# will adjust the colors in the style sheet and background images according to

‎doc/footer.html‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<!-- HTML footer for doxygen 1.9.1-->
2+
<!-- start footer part -->
3+
<!--BEGIN GENERATE_TREEVIEW-->
4+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
5+
<ul>
6+
$navpath
7+
<li class="footer">$generatedby <a href="https://www.doxygen.org/index.html"><img class="footer" src="$relpath^doxygen.svg" width="104" height="31" alt="doxygen"/></a> $doxygenversion </li>
8+
</ul>
9+
</div>
10+
<!--END GENERATE_TREEVIEW-->
11+
<!--BEGIN !GENERATE_TREEVIEW-->
12+
<hr class="footer"/><address class="footer"><small>
13+
$generatedby&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="$relpath^doxygen.svg" width="104" height="31" alt="doxygen"/></a> $doxygenversion
14+
</small></address>
15+
<!--END !GENERATE_TREEVIEW-->
16+
</body>
17+
</html>

‎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.9.1-->
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+
<script type="text/javascript" src="$relpath^jquery.js"></script>
13+
<script type="text/javascript" src="$relpath^dynsections.js"></script>
14+
$treeview
15+
$search
16+
$mathjax
17+
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
18+
<link rel="shortcut icon" href="$relpath^icon.ico" type="image/x-icon" />
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">$projectname
35+
<!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
36+
</div>
37+
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--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/landing/readme.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,9 @@ Ph.D. Disserations:
8181
V. Coralic (2014) Ph.D. thesis, California Institute of Technology
8282
</a>
8383

84-
### User Configuration (`defaults.yaml`)
84+
### User Configuration
8585

86-
The `mfc.sh` script used in the previous section is configured through the file named `defaults.yaml`.
86+
The [mfc.sh](https://github.com/MFlowCode/MFC/blob/master/mfc.sh) script used in the previous section is configured through the [defaults.yaml](https://github.com/MFlowCode/MFC/blob/master/defaults.yaml) file.
8787

8888
## Development
8989

@@ -112,7 +112,7 @@ You can append `-DMFC_MEMORY_DUMP` to `release-gpu`'s Fortran compiler options i
112112
## License
113113

114114
Copyright 2022.
115-
MFC is under the MIT license (see [LICENSE](LICENSE) file for full text).
115+
MFC is under the MIT license (see [LICENSE](https://github.com/MFlowCode/MFC/blob/master/LICENSE) file for full text).
116116

117117
## Acknowledgements
118118

0 commit comments

Comments
 (0)