Merge pull request #7192 from benj5378/docs

[Doc] Migrate WebDoc to doxygen 1.9.4 and improve layout
This commit is contained in:
Yorik van Havre
2022-07-18 10:41:14 +02:00
committed by GitHub
5 changed files with 1987 additions and 1008 deletions

File diff suppressed because it is too large Load Diff

View File

@@ -27,7 +27,7 @@ margin-left: 30px !important;
font-size: 1.15em !important;
}
.navbar{
border: 0px solid #222 !important;
background-color: #222;
}
table{
white-space:pre-wrap !important;
@@ -36,81 +36,6 @@ table{
===========================
*/
/* Sticky footer styles
-------------------------------------------------- */
html,
body {
height: 100%;
/* The html and body elements cannot have any padding or margin. */
}
/* Wrapper for page content to push down footer */
#wrap {
min-height: 100%;
height: auto;
/* Negative indent footer by its height */
margin: 0 auto -60px;
/* Pad bottom by footer height */
padding: 0 0 60px;
}
/* Set the fixed height of the footer here */
#footer {
font-size: 0.9em;
padding: 8px 0px;
background-color: #f5f5f5;
}
.footer-row {
line-height: 44px;
}
#footer > .container {
padding-left: 15px;
padding-right: 15px;
}
.footer-follow-icon {
margin-left: 3px;
text-decoration: none !important;
}
.footer-follow-icon img {
width: 20px;
}
.footer-link {
padding-top: 5px;
display: inline-block;
color: #999999;
text-decoration: none;
}
.footer-copyright {
text-align: center;
}
@media (min-width: 992px) {
.footer-row {
text-align: left;
}
.footer-icons {
text-align: right;
}
}
@media (max-width: 991px) {
.footer-row {
text-align: center;
}
.footer-icons {
text-align: center;
}
}
/* DOXYGEN Code Styles
----------------------------------- */
@@ -371,9 +296,6 @@ span.SRScope {
.summary {
margin-top: 25px;
}
.page-header {
margin: 20px 0px !important;
}
.page-header .title {
display: inline-block;
}
@@ -386,13 +308,6 @@ span.SRScope {
}
/* FreeCAD-specific */
.maincontents {
margin-top: 50px;
}
address.footer {
text-align: center;
margin-bottom: 50px;
}
.directory td.entry {
max-width: 400px;
}
@@ -405,6 +320,51 @@ pre.fragment {
.memdoc p {
text-align: left;
}
body, table, div, p, dl {
font: 400 16px/22px Fira Sans,sans-serif;
.maincontents {
display: none;
}
body {
display: flex;
min-height: 100vh;
flex-direction: column;
justify-content: space-between;
}
body, table, div, p, dl {
font: 400 16px/22px 'Fira Sans' ,sans-serif;
}
#main-nav {
display: none;
}
.navbar {
font-family: 'Roboto', sans-serif;
text-transform: uppercase;
list-style-type: none;
margin: 0;
padding: 0;
overflow: hidden;
background-color: #222;
display: flex;
gap: 20px;
align-items: center;
height: 72px;
padding: 0 10px;
}
.navbar li {
float: left;
}
.navbar li a {
color: #fff;
display: block;
}
.navbar logo {
height: 140px
}
.footer {
background-color: #222;
padding: 25px 0;
color: #eee;
text-align: center !important;
}
.sm.sm-dox {
display: none;
}

View File

@@ -151,9 +151,9 @@ $( document ).ready(function() {
searchBox.CloseResultsWindow();
});
$('body').append('<div id="MSearchClose"></div>');
$('body').append('<div id="MSearchBox"></div>');
$('body').append('<div id="MSearchSelectWindow"></div>');
$('wrapper').append('<div id="MSearchClose"></div>');
$('wrapper').append('<div id="MSearchBox"></div>');
$('wrapper').append('<div id="MSearchSelectWindow"></div>');
searchBox.searchLabel = '';
searchBox.DOMSearchField = function() {

View File

@@ -1,32 +1,18 @@
<!-- HTML footer for doxygen 1.8.8-->
<!-- HTML footer for doxygen 1.9.4-->
</div>
<!-- start footer part -->
<!--BEGIN GENERATE_TREEVIEW-->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
$navpath
<li class="footer">$generatedby
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/></a> $doxygenversion </li>
<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>
</ul>
</div>
<!--END GENERATE_TREEVIEW-->
</div>
</div>
</div>
</div>
</div>
<!--BEGIN !GENERATE_TREEVIEW-->
<address class="footer">
<small>
<a rel="license" href="http://creativecommons.org/licenses/by/4.0/">
<img alt="Creative Commons Licence" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/80x15.png" />
</a> &#160;
$generatedby &#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/>
</a> $doxygenversion
</small>
</address>
<hr /><address class="footer"><small>
$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
</small></address>
<!--END !GENERATE_TREEVIEW-->
</body>
</html>

View File

@@ -1,20 +1,20 @@
<!-- HTML header for doxygen 1.8.8-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- HTML header for doxygen 1.9.4-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<!-- For Mobile Devices -->
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta name="generator" content="Doxygen $doxygenversion"/>
<script type="text/javascript" src="$relpath^jquery.js"></script>
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=11" />
<meta name="generator" content="Doxygen $doxygenversion" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<!--BEGIN PROJECT_NAME-->
<title>$projectname: $title</title>
<!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME-->
<title>$title</title>
<!--END !PROJECT_NAME-->
<!--<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>-->
<script type="text/javascript" src="$relpath^dynsections.js"></script>
<script type="text/javascript" src="$relpath^jquery.js"></script>
$treeview
$search
$mathjax
@@ -25,22 +25,18 @@
<script type="text/javascript" src="$relpath^doxy-boot.js"></script>
<link rel="shortcut icon" href="https://freecadweb.org/images/favicon.ico">
</head>
<body>
<ul class="navbar" role="navigation">
<li>
<a href="https://freecadweb.org" title="FreeCAD">
<img src="https://freecadweb.org/images/freecad-logo.png">
</a>
</li>
<li><a href="$relpath^index.html" title="Index">Index</a></li>
<li><a href="$relpath^modules.html" title="Modules list">Modules</a></li>
<li><a href="$relpath^annotated.html" title="Annotated list">Classes</a></li>
</ul>
<div id="top" class="maincontents"><!-- do not remove this div, it is closed by doxygen! -->
<div class="content" id="content">
<div class="container">
<div class="row">
<div class="col-sm-12 panel " style="padding-bottom: 15px;">
<div style="margin-bottom: 15px;">
<body>
<div class="wrapper">
<ul class="navbar" role="navigation">
<li>
<a href="https://freecadweb.org" title="FreeCAD">
<img class="logo" src="https://www.freecad.org/svg/logo-freecad.svg">
</a>
</li>
<li><a href="$relpath^index.html" title="Index">Index</a></li>
<li><a href="$relpath^modules.html" title="Modules list">Modules</a></li>
<li><a href="$relpath^annotated.html" title="Annotated list">Classes</a></li>
</ul>
<div id="top" class="maincontents"><!-- do not remove this div, it is closed by doxygen! -->
<!-- end header part -->