Skip to content

Commit 53f62e8

Browse files
SpectraL519SpectraL519
committed
still dupa
1 parent 5160b21 commit 53f62e8

4 files changed

Lines changed: 111 additions & 7 deletions

File tree

‎Doxyfile‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1054,7 +1054,7 @@ EXAMPLE_RECURSIVE = NO
10541054
# that contain images that are to be included in the documentation (see the
10551055
# \image command).
10561056

1057-
IMAGE_PATH =
1057+
IMAGE_PATH = docs/img
10581058

10591059
# The INPUT_FILTER tag can be used to specify a program that doxygen should
10601060
# invoke to filter for each input file. Doxygen will invoke the filter program
@@ -1275,7 +1275,7 @@ HTML_FILE_EXTENSION = .html
12751275
# of the possible markers and block names see the documentation.
12761276
# This tag requires that the tag GENERATE_HTML is set to YES.
12771277

1278-
HTML_HEADER =
1278+
HTML_HEADER = docs/style/header.html
12791279

12801280
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
12811281
# generated HTML page. If the tag is left blank doxygen will generate a standard
@@ -1325,7 +1325,11 @@ HTML_EXTRA_STYLESHEET = docs/style/doxygen-awesome-css/doxygen-awesome.css
13251325
# files will be copied as-is; there are no commands or markers available.
13261326
# This tag requires that the tag GENERATE_HTML is set to YES.
13271327

1328-
HTML_EXTRA_FILES =
1328+
HTML_EXTRA_FILES = \
1329+
docs/style/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js \
1330+
docs/style/doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js \
1331+
docs/style/doxygen-awesome-css/doxygen-awesome-paragraph-link.js \
1332+
docs/style/doxygen-awesome-css/doxygen-awesome-interactive-toc.js
13291333

13301334
# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
13311335
# should be rendered with a dark or light theme.
@@ -1743,7 +1747,7 @@ FORMULA_MACROFILE =
17431747
# The default value is: NO.
17441748
# This tag requires that the tag GENERATE_HTML is set to YES.
17451749

1746-
USE_MATHJAX = NO
1750+
USE_MATHJAX = YES
17471751

17481752
# With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
17491753
# Note that the different versions of MathJax have different requirements with
@@ -2187,7 +2191,7 @@ MAN_LINKS = NO
21872191
# captures the structure of the code including all documentation.
21882192
# The default value is: NO.
21892193

2190-
GENERATE_XML = NO
2194+
GENERATE_XML = YES
21912195

21922196
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
21932197
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

‎README.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
- [Dev notes - TODO](#dev-notes---todo)
4343
- [Compiler support](#compiler-support)
4444
- [Licence](#licence)
45+
- [Mathematics](#mathematics)
4546

4647
<br />
4748

@@ -109,3 +110,19 @@ target_link_libraries(my_project PRIVATE cpp-gl)
109110
## Licence
110111

111112
The `CPP-GL` project uses the [MIT Licence](https://mit-license.org/) which can be found in the [LICENCE](/LICENSE) file
113+
114+
115+
## Mathematics
116+
Here is an inline math equation using standard dollars: $V = E - F + 2$,
117+
and one using Big-O: $\mathcal{O}(\vert V \vert + \vert E \vert)$.
118+
And here is a normal (multiline) math block:
119+
120+
$$
121+
\sum_{v \in V} \text{deg}(v) = 2 \vert E \vert
122+
$$
123+
124+
Or alternatively for environments like cases:
125+
126+
$$
127+
A_{i,j} = \begin{cases} 1 & \text{if } (i,j) \in E \\\\ 0 & \text{otherwise} \end{cases}
128+
$$

‎docs/style/header.html‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
<!-- HTML header for doxygen 1.9.8-->
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" lang="$langISO">
4+
<head>
5+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
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+
<!--BEGIN DISABLE_INDEX-->
13+
<!--BEGIN FULL_SIDEBAR-->
14+
<script type="text/javascript">var page_layout=1;</script>
15+
<!--END FULL_SIDEBAR-->
16+
<!--END DISABLE_INDEX-->
17+
<script type="text/javascript" src="$relpath^jquery.js"></script>
18+
<script type="text/javascript" src="$relpath^dynsections.js"></script>
19+
$treeview
20+
$search
21+
$mathjax
22+
$darkmode
23+
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
24+
$extrastylesheet
25+
<script type="text/javascript" src="$relpath^doxygen-awesome-darkmode-toggle.js"></script>
26+
<script type="text/javascript" src="$relpath^doxygen-awesome-fragment-copy-button.js"></script>
27+
<script type="text/javascript" src="$relpath^doxygen-awesome-interactive-toc.js"></script>
28+
<script type="text/javascript">
29+
DoxygenAwesomeDarkModeToggle.init()
30+
DoxygenAwesomeFragmentCopyButton.init()
31+
DoxygenAwesomeInteractiveToc.init()
32+
</script>
33+
</head>
34+
<body>
35+
<!--BEGIN DISABLE_INDEX-->
36+
<!--BEGIN FULL_SIDEBAR-->
37+
<div id="side-nav" class="ui-resizable side-nav-resizable"><!-- do not remove this div, it is closed by doxygen! -->
38+
<!--END FULL_SIDEBAR-->
39+
<!--END DISABLE_INDEX-->
40+
41+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
42+
43+
<!--BEGIN TITLEAREA-->
44+
<div id="titlearea">
45+
<table cellspacing="0" cellpadding="0">
46+
<tbody>
47+
<tr id="projectrow">
48+
<!--BEGIN PROJECT_LOGO-->
49+
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
50+
<!--END PROJECT_LOGO-->
51+
<!--BEGIN PROJECT_NAME-->
52+
<td id="projectalign">
53+
<div id="projectname">$projectname<!--BEGIN PROJECT_NUMBER--><span id="projectnumber">&#160;$projectnumber</span><!--END PROJECT_NUMBER-->
54+
</div>
55+
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
56+
</td>
57+
<!--END PROJECT_NAME-->
58+
<!--BEGIN !PROJECT_NAME-->
59+
<!--BEGIN PROJECT_BRIEF-->
60+
<td>
61+
<div id="projectbrief">$projectbrief</div>
62+
</td>
63+
<!--END PROJECT_BRIEF-->
64+
<!--END !PROJECT_NAME-->
65+
<!--BEGIN DISABLE_INDEX-->
66+
<!--BEGIN SEARCHENGINE-->
67+
<!--BEGIN !FULL_SIDEBAR-->
68+
<td>$searchbox</td>
69+
<!--END !FULL_SIDEBAR-->
70+
<!--END SEARCHENGINE-->
71+
<!--END DISABLE_INDEX-->
72+
</tr>
73+
<!--BEGIN SEARCHENGINE-->
74+
<!--BEGIN FULL_SIDEBAR-->
75+
<tr><td colspan="2">$searchbox</td></tr>
76+
<!--END FULL_SIDEBAR-->
77+
<!--END SEARCHENGINE-->
78+
</tbody>
79+
</table>
80+
</div>
81+
<!--END TITLEAREA-->
82+
<!-- end header part -->

‎include/gl/graph.hpp‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,8 @@ struct to_impl;
7575
/// @tparam GraphTraits An instantiation of @ref gl::graph_traits
7676
///
7777
/// ### Mathematics
78-
/// Here is an inline math equation using standard dollars: $V = E - F + 2$,
79-
/// and one using Big-O: $\mathcal{O}(\vert V \vert + \vert E \vert)$.
78+
/// Here is an inline math equation using standard dollars: \f$V = E - F + 2\f$,
79+
/// and one using Big-O: \f$\mathcal{O}(\vert V \vert + \vert E \vert)\f$.
8080
///
8181
/// And here is a normal (multiline) math block:
8282
///
@@ -107,6 +107,7 @@ struct to_impl;
107107
/// ### References
108108
/// For a general overview and integration instructions, see the [Project Overview](/#overview)
109109
/// or the [Installation Guide](/#installing-the-library).
110+
/// A simple reference: @ref README
110111
///
111112
/// > [!WARNING]
112113
/// > This class relies on its internal implementation tag to correctly define its layout. Modifying

0 commit comments

Comments
 (0)