Skip to content

Commit 63ce40e

Browse files
mzimbresmzimbres
authored
Merge pull request #159 from anarthal/feature/158-boost-docs-formatting-problems
Fixed CSS formatting for Boost docs
2 parents 0c06be6 + f2a005a commit 63ce40e

File tree

5 files changed

+158
-66
lines changed

5 files changed

+158
-66
lines changed

‎doc/Jamfile

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ path-constant include_dir : ../include ;
1212
path-constant examples_dir : ../example ;
1313
path-constant readme : ../README.md ;
1414
path-constant layout_file : DoxygenLayout.xml ;
15+
path-constant header : header.html ;
16+
path-constant footer : footer.html ;
1517

1618
local stylesheet_files = [ path.glob $(this_dir) : *.css ] ;
1719
local includes = [ path.glob-tree $(include_dir) : *.hpp *.cpp ] ;
@@ -46,10 +48,13 @@ doxygen doc.html
4648
<doxygen:param>EXCLUDE_SYMBOLS=std
4749
<doxygen:param>"USE_MDFILE_AS_MAINPAGE=\"$(readme)\""
4850
<doxygen:param>SOURCE_BROWSER=YES
51+
<doxygen:param>"HTML_HEADER=\"$(header)\""
52+
<doxygen:param>"HTML_FOOTER=\"$(footer)\""
4953
<doxygen:param>"HTML_EXTRA_STYLESHEET=$(stylesheet_arg)"
5054
<doxygen:param>HTML_TIMESTAMP=YES
5155
<doxygen:param>GENERATE_TREEVIEW=YES
52-
<doxygen:param>FULL_SIDEBAR=NO
56+
<doxygen:param>FULL_SIDEBAR=YES
57+
<doxygen:param>DISABLE_INDEX=YES
5358
<doxygen:param>ENUM_VALUES_PER_LINE=0
5459
<doxygen:param>OBFUSCATE_EMAILS=YES
5560
<doxygen:param>USE_MATHJAX=YES

‎doc/doxygen-awesome-sidebar-only.css

Lines changed: 72 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -32,84 +32,112 @@ html {
3232
* Make sure it is wide enough to contain the page title (logo + title + version)
3333
*/
3434
--side-nav-fixed-width: 335px;
35-
--menu-display: none;
36-
37-
--top-height: 120px;
38-
--toc-sticky-top: -25px;
39-
--toc-max-height: calc(100vh - 2 * var(--spacing-medium) - 25px);
4035
}
4136

4237
#projectname {
4338
white-space: nowrap;
4439
}
4540

41+
#page-wrapper {
42+
height: calc(100vh - 100px);
43+
}
44+
45+
#content-wrapper {
46+
display: flex;
47+
flex-direction: row;
48+
min-height: 0;
49+
}
50+
51+
#doc-content {
52+
overflow-y: scroll;
53+
flex: 1;
54+
height: auto !important;
55+
}
4656

47-
@media screen and (min-width: 768px) {
57+
@media (min-width: 768px) {
4858
html {
4959
--searchbar-background: var(--page-background-color);
5060
}
5161

52-
#side-nav {
62+
#sidebar-wrapper {
63+
display: flex;
64+
flex-direction: column;
5365
min-width: var(--side-nav-fixed-width);
54-
max-width: var(--side-nav-fixed-width);
55-
top: var(--top-height);
56-
overflow: visible;
66+
max-width: var(--side-nav-fixed-width);
67+
background-color: var(--side-nav-background);
68+
border-right: 1px solid rgb(222, 222, 222);
5769
}
5870

59-
#nav-tree, #side-nav {
60-
height: calc(100vh - var(--top-height)) !important;
71+
#search-box-wrapper {
72+
display: flex;
73+
flex-direction: row;
74+
padding-left: 1em;
75+
padding-right: 1em;
6176
}
6277

63-
#nav-tree {
64-
padding: 0;
78+
#MSearchBox {
79+
flex: 1;
80+
display: flex;
81+
padding-left: 1em;
82+
padding-right: 1em;
6583
}
6684

67-
#top {
68-
display: block;
69-
border-bottom: none;
70-
height: var(--top-height);
71-
margin-bottom: calc(0px - var(--top-height));
72-
max-width: var(--side-nav-fixed-width);
73-
overflow: hidden;
74-
background: var(--side-nav-background);
85+
86+
#MSearchBox .left {
87+
display: flex;
88+
flex: 1;
89+
position: static;
90+
align-items: center;
91+
justify-content: flex-start;
92+
width: auto;
93+
height: auto;
7594
}
76-
#main-nav {
77-
float: left;
78-
padding-right: 0;
95+
96+
#MSearchBox .right {
97+
display: none;
7998
}
8099

81-
.ui-resizable-handle {
82-
cursor: default;
83-
width: 1px !important;
84-
box-shadow: 0 calc(-2 * var(--top-height)) 0 0 var(--separator-color);
100+
#MSearchSelect {
101+
padding-left: 0.75em;
102+
left: auto;
85103
}
86104

87-
#nav-path {
88-
position: fixed;
89-
right: 0;
90-
left: var(--side-nav-fixed-width);
91-
bottom: 0;
105+
#MSearchField {
106+
flex: 1;
107+
position: static;
92108
width: auto;
109+
height: auto;
93110
}
94111

95-
#doc-content {
96-
height: calc(100vh - 31px) !important;
97-
padding-bottom: calc(3 * var(--spacing-large));
98-
padding-top: calc(var(--top-height) - 80px);
99-
box-sizing: border-box;
100-
margin-left: var(--side-nav-fixed-width) !important;
112+
#nav-tree {
113+
height: auto !important;
101114
}
102115

103-
#MSearchBox {
104-
width: calc(var(--side-nav-fixed-width) - calc(2 * var(--spacing-medium)));
116+
#nav-sync {
117+
display: none;
105118
}
106119

107-
#MSearchField {
108-
width: calc(var(--side-nav-fixed-width) - calc(2 * var(--spacing-medium)) - 65px);
120+
#top {
121+
display: block;
122+
border-bottom: none;
123+
max-width: var(--side-nav-fixed-width);
124+
overflow: hidden;
125+
background: var(--side-nav-background);
126+
}
127+
128+
.ui-resizable-handle {
129+
cursor: default;
130+
width: 1px !important;
109131
}
110132

111133
#MSearchResultsWindow {
112134
left: var(--spacing-medium) !important;
113135
right: auto;
114136
}
115137
}
138+
139+
@media (max-width: 768px) {
140+
#sidebar-wrapper {
141+
display: none;
142+
}
143+
}

‎doc/doxygen-awesome.css

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -552,25 +552,6 @@ a.anchor {
552552
margin-top: 0;
553553
}
554554

555-
/* until Doxygen 1.9.4 */
556-
.left img#MSearchSelect {
557-
left: 0;
558-
user-select: none;
559-
padding-left: 8px;
560-
}
561-
562-
/* Doxygen 1.9.5 */
563-
.left span#MSearchSelect {
564-
left: 0;
565-
user-select: none;
566-
margin-left: 8px;
567-
padding: 0;
568-
}
569-
570-
.left #MSearchSelect[src$=".png"] {
571-
padding-left: 0
572-
}
573-
574555
.SelectionMark {
575556
user-select: none;
576557
}
@@ -614,9 +595,7 @@ a.anchor {
614595

615596
#MSearchField {
616597
font-size: var(--navigation-font-size);
617-
height: calc(var(--searchbar-height) - 2px);
618598
background: transparent;
619-
width: calc(var(--searchbar-width) - 64px);
620599
}
621600

622601
.MSearchBoxActive #MSearchField {

‎doc/footer.html

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!-- HTML footer for doxygen 1.9.1-->
2+
<!-- start footer part -->
3+
</div> <!-- close #content-wrapper -->
4+
<!--BEGIN GENERATE_TREEVIEW-->
5+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
6+
<ul>
7+
$navpath
8+
<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>
9+
</ul>
10+
</div>
11+
<!--END GENERATE_TREEVIEW-->
12+
<!--BEGIN !GENERATE_TREEVIEW-->
13+
<hr class="footer"/><address class="footer"><small>
14+
$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
15+
</small></address>
16+
<!--END !GENERATE_TREEVIEW-->
17+
</div> <!-- #page-wrapper -->
18+
</body>
19+
</html>

‎doc/header.html

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
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+
$extrastylesheet
19+
</head>
20+
<body>
21+
<div id="page-wrapper">
22+
<div id="content-wrapper" style="display: flex; flex-direction: row">
23+
<div id="sidebar-wrapper" style="display: flex; flex-direction: column">
24+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
25+
26+
<!--BEGIN TITLEAREA-->
27+
<div id="titlearea">
28+
<table cellspacing="0" cellpadding="0">
29+
<tbody>
30+
<tr style="height: 56px;">
31+
<!--BEGIN PROJECT_LOGO-->
32+
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
33+
<!--END PROJECT_LOGO-->
34+
<!--BEGIN PROJECT_NAME-->
35+
<td id="projectalign" style="padding-left: 0.5em;">
36+
<div id="projectname">$projectname
37+
<!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
38+
</div>
39+
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
40+
</td>
41+
<!--END PROJECT_NAME-->
42+
<!--BEGIN !PROJECT_NAME-->
43+
<!--BEGIN PROJECT_BRIEF-->
44+
<td style="padding-left: 0.5em;">
45+
<div id="projectbrief">$projectbrief</div>
46+
</td>
47+
<!--END PROJECT_BRIEF-->
48+
<!--END !PROJECT_NAME-->
49+
<!--BEGIN DISABLE_INDEX-->
50+
<!--END DISABLE_INDEX-->
51+
</tr>
52+
</tbody>
53+
</table>
54+
</div>
55+
<!--BEGIN SEARCHENGINE-->
56+
<div id="search-box-wrapper">
57+
$searchbox
58+
</div>
59+
<!--END SEARCHENGINE-->
60+
<!--END TITLEAREA-->
61+
<!-- end header part -->

0 commit comments

Comments
 (0)