Skip to content

Commit

Permalink
Deployed c60b0fb with MkDocs version: 1.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@MB3hel
MB3hel committed May 5, 2024
1 parent d22fa53 commit ab6467d
Show file tree
Hide file tree
Showing 85 changed files with 1,843 additions and 924 deletions.
55 changes: 30 additions & 25 deletions 404.html
100755 → 100644
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,13 @@
<title>AUV Control Board</title>
<link rel="stylesheet" href="/AUVControlBoard/css/theme.css" />
<link rel="stylesheet" href="/AUVControlBoard/css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />

<script src="/AUVControlBoard/js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="/AUVControlBoard/js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
</head>

<body class="wy-body-for-nav" role="document">
Expand All @@ -27,7 +26,7 @@
<a href="/AUVControlBoard/." class="icon icon-home"> AUV Control Board
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="/AUVControlBoard//search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
</form>
</div>
</div>
Expand All @@ -41,9 +40,11 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="/AUVControlBoard/user_guide/preparing_board/">Preparing a Control Board</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/AUVControlBoard/user_guide/general_use/">Using Control board</a>
<li class="toctree-l1"><a class="reference internal" href="/AUVControlBoard/user_guide/general_use/">Using Control Board</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/AUVControlBoard/user_guide/simulator/">Using the Simulator</a>
<li class="toctree-l1"><a class="reference internal" href="/AUVControlBoard/user_guide/pythoniface/">Using the Python Interface</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/AUVControlBoard/user_guide/simcb_simulator/">Using SimCB and Simulator</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/AUVControlBoard/user_guide/calibration/">Sensor Calibration</a>
</li>
Expand All @@ -63,17 +64,21 @@
</ul>
<p class="caption"><span class="caption-text">Developers</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/AUVControlBoard/firmware/overview/">Overview</a>
<li class="toctree-l1"><a class="reference internal" href="/AUVControlBoard/devs/overview/">Firmware Overview</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/AUVControlBoard/devs/details/">Firmware Details</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/AUVControlBoard/firmware/details/">Implementation Details</a>
<li class="toctree-l1"><a class="reference internal" href="/AUVControlBoard/devs/simulation/">Simulation Support</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/AUVControlBoard/firmware/build/">Build and Flash</a>
<li class="toctree-l1"><a class="reference internal" href="/AUVControlBoard/devs/build/">Build and Flash Firmware</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/AUVControlBoard/firmware/math/">Math</a>
<li class="toctree-l1"><a class="reference internal" href="/AUVControlBoard/devs/buildsimcb/">Build and Run SimCB</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/AUVControlBoard/firmware/developing/">Firmware Development</a>
<li class="toctree-l1"><a class="reference internal" href="/AUVControlBoard/devs/pythoniface/">Interface Scripts</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/AUVControlBoard/firmware/simhijack/">Simulation Support</a>
<li class="toctree-l1"><a class="reference internal" href="/AUVControlBoard/devs/developing/">Development Workflows</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/AUVControlBoard/devs/math/">Math</a>
</li>
</ul>
</div>
Expand All @@ -89,13 +94,12 @@
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="/AUVControlBoard/." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li><a href="/AUVControlBoard/." class="icon icon-home" aria-label="Docs"></a></li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>

<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">

Expand Down Expand Up @@ -135,17 +139,18 @@ <h1 id="404-page-not-found">404</h1>

</span>
</div>
<script>var base_url = '/AUVControlBoard/';</script>
<script src="/AUVControlBoard/js/theme_extra.js" defer></script>
<script src="/AUVControlBoard/js/theme.js" defer></script>
<script src="/AUVControlBoard/js/mathjax.js" defer></script>
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6" defer></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js" defer></script>
<script src="/AUVControlBoard/search/main.js" defer></script>
<script defer>
window.onload = function () {
<script src="/AUVControlBoard/js/jquery-3.6.0.min.js"></script>
<script>var base_url = "/AUVControlBoard/";</script>
<script src="/AUVControlBoard/js/theme_extra.js"></script>
<script src="/AUVControlBoard/js/theme.js"></script>
<script src="/AUVControlBoard/js/mathjax.js"></script>
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<script src="/AUVControlBoard/search/main.js"></script>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
};
});
</script>

</body>
Expand Down
Empty file modified css/fonts/Roboto-Slab-Bold.woff
100755 → 100644
View file
Empty file.
Empty file modified css/fonts/Roboto-Slab-Bold.woff2
100755 → 100644
View file
Empty file.
Empty file modified css/fonts/Roboto-Slab-Regular.woff
100755 → 100644
View file
Empty file.
Empty file modified css/fonts/Roboto-Slab-Regular.woff2
100755 → 100644
View file
Empty file.
Empty file modified css/fonts/fontawesome-webfont.eot
100755 → 100644
View file
Empty file.
Empty file modified css/fonts/fontawesome-webfont.svg
100755 → 100644
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified css/fonts/fontawesome-webfont.ttf
100755 → 100644
View file
Empty file.
Empty file modified css/fonts/fontawesome-webfont.woff
100755 → 100644
View file
Empty file.
Empty file modified css/fonts/fontawesome-webfont.woff2
100755 → 100644
View file
Empty file.
Empty file modified css/fonts/lato-bold-italic.woff
100755 → 100644
View file
Empty file.
Empty file modified css/fonts/lato-bold-italic.woff2
100755 → 100644
View file
Empty file.
Empty file modified css/fonts/lato-bold.woff
100755 → 100644
View file
Empty file.
Empty file modified css/fonts/lato-bold.woff2
100755 → 100644
View file
Empty file.
Empty file modified css/fonts/lato-normal-italic.woff
100755 → 100644
View file
Empty file.
Empty file modified css/fonts/lato-normal-italic.woff2
100755 → 100644
View file
Empty file.
Empty file modified css/fonts/lato-normal.woff
100755 → 100644
View file
Empty file.
Empty file modified css/fonts/lato-normal.woff2
100755 → 100644
View file
Empty file.
6 changes: 3 additions & 3 deletions css/theme.css
100755 → 100644
View file

Large diffs are not rendered by default.

38 changes: 22 additions & 16 deletions css/theme_extra.css
100755 → 100644
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@
* https://github.com/mkdocs/mkdocs/issues/233
*/
.rst-content pre code {
white-space: pre;
word-wrap: normal;
display: block;
padding: 12px;
font-size: 12px;
white-space: pre;
word-wrap: normal;
display: block;
padding: 12px;
font-size: 12px;
}

/**
Expand Down Expand Up @@ -77,9 +77,9 @@ pre .cs, pre .c {
* https://github.com/mkdocs/mkdocs/issues/319
*/
.rst-content .no-highlight {
display: block;
padding: 0.5em;
color: #333;
display: block;
padding: 0.5em;
color: #333;
}


Expand All @@ -103,7 +103,7 @@ pre .cs, pre .c {
form .search-query {
width: 100%;
border-radius: 50px;
padding: 6px 12px; /* csslint allow: box-model */
padding: 6px 12px;
border-color: #D1D4D5;
}

Expand All @@ -113,11 +113,11 @@ form .search-query {
* https://github.com/mkdocs/mkdocs/issues/656
*/
.rst-content .admonition code {
color: #404040;
border: 1px solid #c7c9cb;
border: 1px solid rgba(0, 0, 0, 0.2);
background: #f8fbfd;
background: rgba(255, 255, 255, 0.7);
color: #404040;
border: 1px solid #c7c9cb;
border: 1px solid rgba(0, 0, 0, 0.2);
background: #f8fbfd;
background: rgba(255, 255, 255, 0.7);
}

/*
Expand All @@ -135,8 +135,8 @@ form .search-query {
}

td, th {
border: 1px solid #e1e4e5 !important; /* csslint allow: important */
border-collapse: collapse;
border: 1px solid #e1e4e5 !important;
border-collapse: collapse;
}

/*
Expand All @@ -155,6 +155,12 @@ td, th {
padding-bottom: 40px;
}

/* For section-index only */
.wy-menu-vertical .current-section p {
background-color: #e3e3e3;
color: #404040;
}

/*
* The second step of above amendment: Here we make sure the items are aligned
* correctly within the .rst-current-version container. Using flexbox, we
Expand Down
83 changes: 44 additions & 39 deletions firmware/build/index.html → devs/build/index.html
100755 → 100644
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,25 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="https://mb3hel.github.io/AUVControlBoard/firmware/build/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="https://mb3hel.github.io/AUVControlBoard/devs/build/" />
<link rel="shortcut icon" href="../../img/favicon.ico" />
<title>Build and Flash - AUV Control Board</title>
<title>Build and Flash Firmware - AUV Control Board</title>
<link rel="stylesheet" href="../../css/theme.css" />
<link rel="stylesheet" href="../../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />

<script>
// Current page data
var mkdocs_page_name = "Build and Flash";
var mkdocs_page_input_path = "firmware\\build.md";
var mkdocs_page_url = "/AUVControlBoard/firmware/build/";
var mkdocs_page_name = "Build and Flash Firmware";
var mkdocs_page_input_path = "devs/build.md";
var mkdocs_page_url = "/AUVControlBoard/devs/build/";
</script>

<script src="../../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
</head>

<body class="wy-body-for-nav" role="document">
Expand All @@ -34,7 +33,7 @@
<a href="../.." class="icon icon-home"> AUV Control Board
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
</form>
</div>
</div>
Expand All @@ -48,9 +47,11 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/preparing_board/">Preparing a Control Board</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/general_use/">Using Control board</a>
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/general_use/">Using Control Board</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/simulator/">Using the Simulator</a>
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/pythoniface/">Using the Python Interface</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/simcb_simulator/">Using SimCB and Simulator</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/calibration/">Sensor Calibration</a>
</li>
Expand All @@ -70,11 +71,13 @@
</ul>
<p class="caption"><span class="caption-text">Developers</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../overview/">Overview</a>
<li class="toctree-l1"><a class="reference internal" href="../overview/">Firmware Overview</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../details/">Firmware Details</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../details/">Implementation Details</a>
<li class="toctree-l1"><a class="reference internal" href="../simulation/">Simulation Support</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Build and Flash</a>
<li class="toctree-l1 current"><a class="reference internal current" href="#">Build and Flash Firmware</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#building">Building</a>
</li>
Expand All @@ -84,11 +87,13 @@
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../math/">Math</a>
<li class="toctree-l1"><a class="reference internal" href="../buildsimcb/">Build and Run SimCB</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../developing/">Firmware Development</a>
<li class="toctree-l1"><a class="reference internal" href="../pythoniface/">Interface Scripts</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../simhijack/">Simulation Support</a>
<li class="toctree-l1"><a class="reference internal" href="../developing/">Development Workflows</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../math/">Math</a>
</li>
</ul>
</div>
Expand All @@ -104,20 +109,19 @@
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../.." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Developers &raquo;</li><li>Build and Flash</li>
<li><a href="../.." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item">Developers</li>
<li class="breadcrumb-item active">Build and Flash Firmware</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/MB3hel/AUVControlBoard/blob/main/docs/docs/firmware/build.md"
class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/MB3hel/AUVControlBoard/blob/main/docs/docs/devs/build.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>

<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">

<h1 id="build-and-flash">Build and Flash</h1>
<h1 id="build-and-flash-firmware">Build and Flash Firmware</h1>
<p><em>Note: Run all commands shown in the <code>firmware</code> folder of the repo.</em></p>
<h2 id="building">Building</h2>
<p>Install the Required Tools:</p>
Expand All @@ -127,7 +131,7 @@ <h2 id="building">Building</h2>
<li><a href="https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads">GNU Arm Toolchain</a></li>
</ul>
<p><em>Make sure <code>cmake</code>, <code>ninja</code>, and <code>arm-none-eabi-gcc</code> are in your <code>PATH</code>.</em></p>
<p>Build the firmware using the commands below. Replace <code>[preset]</code> with <code>v1</code> or <code>v2</code>. Replace <code>[config]</code> with <code>debug</code>, <code>release</code>, <code>minsizerel</code>, or <code>relwithdebinfo</code>.</p>
<p>Build the firmware using the commands below. Replace<code>[preset]</code> with <code>v1</code> or <code>v2</code> (depending on which version you are building firmware for). Replace <code>[config]</code> with <code>debug</code>, <code>release</code>, <code>minsizerel</code>, or <code>relwithdebinfo</code>.</p>
<pre><code class="language-sh">cmake --preset=[preset]
cmake --build --preset=[preset]-[config]
</code></pre>
Expand Down Expand Up @@ -227,8 +231,8 @@ <h2 id="flashing-remotely">Flashing Remotely</h2>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../details/" class="btn btn-neutral float-left" title="Implementation Details"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../math/" class="btn btn-neutral float-right" title="Math">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../simulation/" class="btn btn-neutral float-left" title="Simulation Support"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../buildsimcb/" class="btn btn-neutral float-right" title="Build and Run SimCB">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>

<hr/>
Expand All @@ -255,24 +259,25 @@ <h2 id="flashing-remotely">Flashing Remotely</h2>
</span>


<span><a href="../details/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../simulation/" style="color: #fcfcfc">&laquo; Previous</a></span>


<span><a href="../math/" style="color: #fcfcfc">Next &raquo;</a></span>
<span><a href="../buildsimcb/" style="color: #fcfcfc">Next &raquo;</a></span>

</span>
</div>
<script>var base_url = '../..';</script>
<script src="../../js/theme_extra.js" defer></script>
<script src="../../js/theme.js" defer></script>
<script src="../../js/mathjax.js" defer></script>
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6" defer></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js" defer></script>
<script src="../../search/main.js" defer></script>
<script defer>
window.onload = function () {
<script src="../../js/jquery-3.6.0.min.js"></script>
<script>var base_url = "../..";</script>
<script src="../../js/theme_extra.js"></script>
<script src="../../js/theme.js"></script>
<script src="../../js/mathjax.js"></script>
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<script src="../../search/main.js"></script>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
};
});
</script>

</body>
Expand Down
Loading

0 comments on commit ab6467d

Please sign in to comment.