Skip to content

Commit

Permalink
Deployed b0a8710 with MkDocs version: 1.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@efcy
efcy committed May 2, 2024
1 parent 5666481 commit 241b755
Show file tree
Hide file tree
Showing 43 changed files with 3,635 additions and 1,183 deletions.
63 changes: 55 additions & 8 deletions 404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -689,9 +689,35 @@




<li class="md-nav__item md-nav__item--nested">


<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >




<label class="md-nav__link" for="__nav_4_3">
Working With Robots
<span class="md-nav__icon md-icon"></span>
</label>

<nav class="md-nav" aria-label="Working With Robots" data-md-level="2">
<label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span>
Working With Robots
</label>
<ul class="md-nav__list" data-md-scrollfix>






<li class="md-nav__item">
<a href="/guides/working-with-logfiles/working-with-logfiles/" class="md-nav__link">
Working with logfiles
<a href="/guides/robot_handling/" class="md-nav__link">
Handling the Robot
</a>
</li>

Expand All @@ -704,22 +730,43 @@


<li class="md-nav__item">
<a href="/guides/working-with-sound/working-with-sound/" class="md-nav__link">
Sound
<a href="/guides/robots/known-robot-issues/" class="md-nav__link">
Known Issues with Robots
</a>
</li>




</ul>
</nav>
</li>









<li class="md-nav__item">
<a href="/guides/robot_handling/" class="md-nav__link">
Handling the Robot
<a href="/guides/working-with-logfiles/working-with-logfiles/" class="md-nav__link">
Working with logfiles
</a>
</li>









<li class="md-nav__item">
<a href="/guides/working-with-sound/working-with-sound/" class="md-nav__link">
Sound
</a>
</li>

Expand Down Expand Up @@ -889,7 +936,7 @@


<li class="md-nav__item">
<a href="/guides/deeplearning/deep_learning_annotation/" class="md-nav__link">
<a href="/guides/deeplearning/data_prep/" class="md-nav__link">
Data Prep for Deep Learning
</a>
</li>
Expand Down Expand Up @@ -1029,7 +1076,7 @@ <h1>404 - Not found</h1>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "/", "features": ["navigation.tabs", "navigation.tabs.sticky"], "search": "/assets/javascripts/workers/search.85cb4492.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script>
<script id="__config" type="application/json">{"base": "/", "features": ["navigation.tabs", "navigation.tabs.sticky", "toc.follow"], "search": "/assets/javascripts/workers/search.85cb4492.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script>


<script src="/assets/javascripts/bundle.a877e258.min.js"></script>
Expand Down
77 changes: 62 additions & 15 deletions guides/coding_guidelines/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -698,9 +698,35 @@




<li class="md-nav__item md-nav__item--nested">


<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >




<label class="md-nav__link" for="__nav_4_3">
Working With Robots
<span class="md-nav__icon md-icon"></span>
</label>

<nav class="md-nav" aria-label="Working With Robots" data-md-level="2">
<label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span>
Working With Robots
</label>
<ul class="md-nav__list" data-md-scrollfix>






<li class="md-nav__item">
<a href="../working-with-logfiles/working-with-logfiles/" class="md-nav__link">
Working with logfiles
<a href="../robot_handling/" class="md-nav__link">
Handling the Robot
</a>
</li>

Expand All @@ -713,22 +739,43 @@


<li class="md-nav__item">
<a href="../working-with-sound/working-with-sound/" class="md-nav__link">
Sound
<a href="../robots/known-robot-issues/" class="md-nav__link">
Known Issues with Robots
</a>
</li>




</ul>
</nav>
</li>









<li class="md-nav__item">
<a href="../robot_handling/" class="md-nav__link">
Handling the Robot
<a href="../working-with-logfiles/working-with-logfiles/" class="md-nav__link">
Working with logfiles
</a>
</li>









<li class="md-nav__item">
<a href="../working-with-sound/working-with-sound/" class="md-nav__link">
Sound
</a>
</li>

Expand Down Expand Up @@ -976,7 +1023,7 @@


<li class="md-nav__item">
<a href="../deeplearning/deep_learning_annotation/" class="md-nav__link">
<a href="../deeplearning/data_prep/" class="md-nav__link">
Data Prep for Deep Learning
</a>
</li>
Expand Down Expand Up @@ -1093,8 +1140,8 @@



<div><h1 id="coding-guidelines">Coding Guidelines</h1>
<h2 id="git">Git</h2>
<div><h1 id="coding-guidelines">Coding Guidelines<a class="headerlink" href="#coding-guidelines" title="Permanent link"></a></h1>
<h2 id="git">Git<a class="headerlink" href="#git" title="Permanent link"></a></h2>
<ul>
<li>Don't use capital letters in branch names, see https://stackoverflow.com/a/38494084/3866740</li>
<li>We use a four-eye principle for merging. Create a merge request in gitlab and ask another developer to approve the changes.</li>
Expand All @@ -1103,7 +1150,7 @@ <h2 id="git">Git</h2>
<li>Ideally a branch addresses on feature or bug. This makes it easier to test and review.</li>
<li>The merge request should explain the changes and link to an issue where applicable.</li>
</ul>
<h2 id="python">Python</h2>
<h2 id="python">Python<a class="headerlink" href="#python" title="Permanent link"></a></h2>
<ul>
<li>In general use python version 3.6.9</li>
<li>comply with the <a href="https://www.python.org/dev/peps/pep-0008/">PEP8 standard</a></li>
Expand All @@ -1114,20 +1161,20 @@ <h2 id="python">Python</h2>
</ul>
<hr>
<p>Some code guidelines can be automatically enforced with an .editorconfig file (https://editorconfig.org/) if the used editor or IDE supports this.</p>
<h2 id="encoding">Encoding</h2>
<h2 id="encoding">Encoding<a class="headerlink" href="#encoding" title="Permanent link"></a></h2>
<p>The following command lists all <code>*.cpp</code>-files with non trivial encoding, i.e., they might contain some special characters:
</p><div class="highlight"><pre><span></span><code>/bin/find . -type f -name *.cpp -exec file --mime-encoding {} \; | grep -v us-ascii
</code></pre></div>
All files should be in <code>utf-8</code> encoding but should only use ascii characters.
<h2 id="tabs-vs-spaces">Tabs vs. Spaces</h2>
<h2 id="tabs-vs-spaces">Tabs vs. Spaces<a class="headerlink" href="#tabs-vs-spaces" title="Permanent link"></a></h2>
<p>No tab characters should be used. Instead we should use always 4 spaces.</p>
<h2 id="brace-formatting">Brace Formatting</h2>
<h2 id="brace-formatting">Brace Formatting<a class="headerlink" href="#brace-formatting" title="Permanent link"></a></h2>
<p>In C++ braces should always be like that:<br>
</p><div class="highlight"><pre><span></span><code><span class="kt">int</span><span class="w"> </span><span class="nf">myFunction</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="n">Vector2d</span><span class="o">&amp;</span><span class="w"> </span><span class="n">v</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div>
<h2 id="module-conventions">Module Conventions</h2>
<h2 id="module-conventions">Module Conventions<a class="headerlink" href="#module-conventions" title="Permanent link"></a></h2>
<ul>
<li>parameter Class should be named <code>Parameter</code></li>
<li>the object of the parameter class should be called params</li>
Expand Down Expand Up @@ -1219,7 +1266,7 @@ <h2 id="module-conventions">Module Conventions</h2>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.tabs.sticky"], "search": "../../assets/javascripts/workers/search.85cb4492.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.tabs.sticky", "toc.follow"], "search": "../../assets/javascripts/workers/search.85cb4492.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script>


<script src="../../assets/javascripts/bundle.a877e258.min.js"></script>
Expand Down
Loading

0 comments on commit 241b755

Please sign in to comment.