Skip to content

Commit e6a4329

Browse files
afhafh
committed
doc: Add custom html header for api documentation
1 parent 618dab1 commit e6a4329

File tree

2 files changed

+91
-0
lines changed

2 files changed

+91
-0
lines changed

‎apidoc_header.html

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
<!-- HTML header for doxygen 1.9.6-->
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+
</head>
26+
<body>
27+
<!--BEGIN DISABLE_INDEX-->
28+
<!--BEGIN FULL_SIDEBAR-->
29+
<div id="side-nav" class="ui-resizable side-nav-resizable"><!-- do not remove this div, it is closed by doxygen! -->
30+
<!--END FULL_SIDEBAR-->
31+
<!--END DISABLE_INDEX-->
32+
33+
<!-- BEGIN LEDGER_HEADER -->
34+
<style type="text/css">
35+
@import url("https://ledger-cli.org/stylesheets/site.css");
36+
header, #main-nav { max-width: 60em; margin: auto; }
37+
header { margin-bottom: 1em; }
38+
</style>
39+
<aside>
40+
<a href="https://git.ledger-cli.org/ledger" class="github-corner" aria-label="View source on GitHub"><svg width="80" height="80" viewBox="0 0 250 250" style="fill:#151513; color:#fff; position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true"><title>Fork me on GitHub</title><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a>
41+
</aside>
42+
<header>
43+
<nav>
44+
<ul>
45+
<li><a href="/">ledger $projectnumber</a></li>
46+
<li><a href="/index.html">Home</a></li>
47+
<li><a href="/features.html">Features</a></li>
48+
<li><a href="/docs.html">Docs</a></li>
49+
<li><a href="/download.html">Download</a></li>
50+
<li><a href="/contribute.html">Contribute</a></li>
51+
<li><a href="https://wiki.ledger-cli.org/">Wiki</a></li>
52+
</ul>
53+
</nav>
54+
</header>
55+
<!-- END LEDGER_HEADER -->
56+
57+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
58+
59+
<!--BEGIN TITLEAREA-->
60+
<div id="titlearea">
61+
<table cellspacing="0" cellpadding="0">
62+
<tbody>
63+
<tr id="projectrow">
64+
<!--BEGIN PROJECT_LOGO-->
65+
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
66+
<!--END PROJECT_LOGO-->
67+
<!--BEGIN PROJECT_BRIEF-->
68+
<td>
69+
<div id="projectbrief">$projectbrief</div>
70+
</td>
71+
<!--END PROJECT_BRIEF-->
72+
<!--END !PROJECT_NAME-->
73+
<!--BEGIN DISABLE_INDEX-->
74+
<!--BEGIN SEARCHENGINE-->
75+
<!--BEGIN !FULL_SIDEBAR-->
76+
<td>$searchbox</td>
77+
<!--END !FULL_SIDEBAR-->
78+
<!--END SEARCHENGINE-->
79+
<!--END DISABLE_INDEX-->
80+
</tr>
81+
<!--BEGIN SEARCHENGINE-->
82+
<!--BEGIN FULL_SIDEBAR-->
83+
<tr><td colspan="2">$searchbox</td></tr>
84+
<!--END FULL_SIDEBAR-->
85+
<!--END SEARCHENGINE-->
86+
</tbody>
87+
</table>
88+
</div>
89+
<!--END TITLEAREA-->
90+
<!-- end header part -->

‎flake.nix

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@
7373
"-Wno-dev"
7474
"-DUSE_DOXYGEN:BOOL=ON"
7575
"-DDOXYGEN_EXTRA_CSS:STRING=${doxygen-awesome}/doxygen-awesome.css"
76+
"-DDOXYGEN_HTML_HEADER:STRING=${self}/apidoc_header.html"
7677
];
7778

7879
# Ensure the "generated on date at time" footer shows the actual date and time

0 commit comments

Comments
 (0)