Deploying to gh-pages from @ 3b91a7d 🚀

_static/basic.css

@@ -237,6 +237,10 @@ a.headerlink {
  visibility: hidden;
 }
 
+a:visited {
+ color: #551A8B;
+}
+
 h1:hover > a.headerlink,
 h2:hover > a.headerlink,
 h3:hover > a.headerlink,
@@ -670,6 +674,16 @@ dd {
  margin-left: 30px;
 }
 
+.sig dd {
+ margin-top: 0px;
+ margin-bottom: 0px;
+}
+
+.sig dl {
+ margin-top: 0px;
+ margin-bottom: 0px;
+}
+
 dl > dd:last-child,
 dl > dd:last-child > :last-child {
  margin-bottom: 0;
@@ -738,6 +752,14 @@ abbr, acronym {
  cursor: help;
 }
 
+.translated {
+ background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+ background-color: rgba(255, 207, 207, 0.2)
+}
+
 /* -- code displays --------------------------------------------------------- */
 
 pre {

_static/documentation_options.js

@@ -1,5 +1,4 @@
-var DOCUMENTATION_OPTIONS = {
- URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
+const DOCUMENTATION_OPTIONS = {
  VERSION: '1.0a1',
  LANGUAGE: 'en',
  COLLAPSE_INDEX: false,

_static/searchtools.js

@@ -57,12 +57,12 @@ const _removeChildren = (element) => {
 const _escapeRegExp = (string) =>
  string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
 
-const _displayItem = (item, searchTerms) => {
+const _displayItem = (item, searchTerms, highlightTerms) => {
  const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
- const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT;
  const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
  const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
  const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
+ const contentRoot = document.documentElement.dataset.content_root;
 
  const [docName, title, anchor, descr, score, _filename] = item;
 
@@ -75,20 +75,24 @@ const _displayItem = (item, searchTerms) => {
  if (dirname.match(/\/index\/$/))
  dirname = dirname.substring(0, dirname.length - 6);
  else if (dirname === "index/") dirname = "";
- requestUrl = docUrlRoot + dirname;
+ requestUrl = contentRoot + dirname;
  linkUrl = requestUrl;
  } else {
  // normal html builders
- requestUrl = docUrlRoot + docName + docFileSuffix;
+ requestUrl = contentRoot + docName + docFileSuffix;
  linkUrl = docName + docLinkSuffix;
  }
  let linkEl = listItem.appendChild(document.createElement("a"));
  linkEl.href = linkUrl + anchor;
  linkEl.dataset.score = score;
  linkEl.innerHTML = title;
- if (descr)
+ if (descr) {
  listItem.appendChild(document.createElement("span")).innerHTML =
  " (" + descr + ")";
+ // highlight search terms in the description
+ if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
+ highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
+ }
  else if (showSearchSummary)
  fetch(requestUrl)
  .then((responseData) => responseData.text())
@@ -97,6 +101,9 @@ const _displayItem = (item, searchTerms) => {
  listItem.appendChild(
  Search.makeSearchSummary(data, searchTerms)
  );
+ // highlight search terms in the summary
+ if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
+ highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
  });
  Search.output.appendChild(listItem);
 };
@@ -115,14 +122,15 @@ const _finishSearch = (resultCount) => {
 const _displayNextItem = (
  results,
  resultCount,
- searchTerms
+ searchTerms,
+ highlightTerms,
 ) => {
  // results left, load the summary and display it
  // this is intended to be dynamic (don't sub resultsCount)
  if (results.length) {
- _displayItem(results.pop(), searchTerms);
+ _displayItem(results.pop(), searchTerms, highlightTerms);
  setTimeout(
- () => _displayNextItem(results, resultCount, searchTerms),
+ () => _displayNextItem(results, resultCount, searchTerms, highlightTerms),
  5
  );
  }
@@ -360,7 +368,7 @@ const Search = {
  // console.info("search results:", Search.lastresults);
 
  // print the results
- _displayNextItem(results, results.length, searchTerms);
+ _displayNextItem(results, results.length, searchTerms, highlightTerms);
  },
 
  /**

_static/sphinx_highlight.js

@@ -29,14 +29,19 @@ const _highlight = (node, addItems, text, className) => {
  }
 
  span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+ const rest = document.createTextNode(val.substr(pos + text.length));
  parent.insertBefore(
  span,
  parent.insertBefore(
- document.createTextNode(val.substr(pos + text.length)),
+ rest,
  node.nextSibling
  )
  );
  node.nodeValue = val.substr(0, pos);
+ /* There may be more occurrences of search term in this node. So call this
+ * function recursively on the remaining fragment.
+ */
+ _highlight(rest, addItems, text, className);
 
  if (isInSVG) {
  const rect = document.createElementNS(
@@ -140,5 +145,10 @@ const SphinxHighlight = {
  },
 };
 
-_ready(SphinxHighlight.highlightSearchWords);
-_ready(SphinxHighlight.initEscapeListener);
+_ready(() => {
+ /* Do not call highlightSearchWords() when we are on the search page.
+ * It will highlight words from the *previous* search query.
+ */
+ if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords();
+ SphinxHighlight.initEscapeListener();
+});

faq.html

@@ -12,11 +12,11 @@
  <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
 
- <script src="_static/jquery.js"></script>
- <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
- <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
- <script src="_static/doctools.js"></script>
- <script src="_static/sphinx_highlight.js"></script>
+ <script src="_static/jquery.js?v=5d32c60e"></script>
+ <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+ <script src="_static/documentation_options.js?v=036e6a88"></script>
+ <script src="_static/doctools.js?v=888ff710"></script>
+ <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
  <script src="_static/js/theme.js"></script>
  <link rel="index" title="Index" href="genindex.html" />
  <link rel="search" title="Search" href="search.html" />
@@ -85,9 +85,9 @@
  <div itemprop="articleBody">
 
  <section id="frequently-asked-questions">
-<span id="faq"></span><h1>Frequently Asked Questions<a class="headerlink" href="#frequently-asked-questions" title="Permalink to this heading"></a></h1>
+<span id="faq"></span><h1>Frequently Asked Questions<a class="headerlink" href="#frequently-asked-questions" title="Link to this heading"></a></h1>
 <section id="how-can-i-get-help">
-<h2>How can I get help?<a class="headerlink" href="#how-can-i-get-help" title="Permalink to this heading"></a></h2>
+<h2>How can I get help?<a class="headerlink" href="#how-can-i-get-help" title="Link to this heading"></a></h2>
 <p>Please start a <a class="reference external" href="https://github.com/IMRCLab/crazyswarm2/discussions">discussion</a> for</p>
 <ul class="simple">
 <li><p>Getting Crazyswarm2 to work with your hardware setup.</p></li>
@@ -96,13 +96,13 @@ <h2>How can I get help?<a class="headerlink" href="#how-can-i-get-help" title="P
 </ul>
 </section>
 <section id="how-can-i-report-an-issue">
-<h2>How can I report an issue?<a class="headerlink" href="#how-can-i-report-an-issue" title="Permalink to this heading"></a></h2>
+<h2>How can I report an issue?<a class="headerlink" href="#how-can-i-report-an-issue" title="Link to this heading"></a></h2>
 <p>If you strongly believe that you found a bug that requires changes in the code, feel free to open an <a class="reference external" href="https://github.com/IMRCLab/crazyswarm2/issues">issue</a>.
 Provide as much details as possible to reproduce the problem, your observation, as well as the desired outcome.</p>
 <p>If you are not sure if a code change is required, please start a <a class="reference external" href="https://github.com/IMRCLab/crazyswarm2/discussions">discussion</a> first.</p>
 </section>
 <section id="how-do-crazyswarm2-and-crazyswarm-differ">
-<h2>How do Crazyswarm2 and Crazyswarm differ?<a class="headerlink" href="#how-do-crazyswarm2-and-crazyswarm-differ" title="Permalink to this heading"></a></h2>
+<h2>How do Crazyswarm2 and Crazyswarm differ?<a class="headerlink" href="#how-do-crazyswarm2-and-crazyswarm-differ" title="Link to this heading"></a></h2>
 <p>Crazyswarm2 was forked from Crazyswarm. However, there is also heavy re-design of core design choices.</p>
 <ul class="simple">
 <li><p><strong>Motion capture integration.</strong>
@@ -125,7 +125,7 @@ <h2>How do Crazyswarm2 and Crazyswarm differ?<a class="headerlink" href="#how-do
 </ul>
 </section>
 <section id="how-is-crazyswarm2-different-from-bitcraze-s-cflib">
-<h2>How is Crazyswarm2 different from Bitcraze’s cflib?<a class="headerlink" href="#how-is-crazyswarm2-different-from-bitcraze-s-cflib" title="Permalink to this heading"></a></h2>
+<h2>How is Crazyswarm2 different from Bitcraze’s cflib?<a class="headerlink" href="#how-is-crazyswarm2-different-from-bitcraze-s-cflib" title="Link to this heading"></a></h2>
 <p>Both can be used to control several Crazyflies from a Python script.
 Here are some differences:</p>
 <ul class="simple">

genindex.html

@@ -11,12 +11,12 @@
  <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
 
- <script src="_static/jquery.js"></script>
- <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
- <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
- <script src="_static/doctools.js"></script>
- <script src="_static/sphinx_highlight.js"></script>
- <script src="_static/tabs.js"></script>
+ <script src="_static/jquery.js?v=5d32c60e"></script>
+ <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+ <script src="_static/documentation_options.js?v=036e6a88"></script>
+ <script src="_static/doctools.js?v=888ff710"></script>
+ <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+ <script src="_static/tabs.js?v=3030b3cb"></script>
  <script src="_static/js/theme.js"></script>
  <link rel="index" title="Index" href="#" />
  <link rel="search" title="Search" href="search.html" /> 

howto.html

@@ -12,11 +12,11 @@
  <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
 
- <script src="_static/jquery.js"></script>
- <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
- <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
- <script src="_static/doctools.js"></script>
- <script src="_static/sphinx_highlight.js"></script>
+ <script src="_static/jquery.js?v=5d32c60e"></script>
+ <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+ <script src="_static/documentation_options.js?v=036e6a88"></script>
+ <script src="_static/doctools.js?v=888ff710"></script>
+ <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
  <script src="_static/js/theme.js"></script>
  <link rel="index" title="Index" href="genindex.html" />
  <link rel="search" title="Search" href="search.html" />
@@ -84,10 +84,10 @@
  <div itemprop="articleBody">
 
  <section id="how-to">
-<span id="howtos"></span><h1>How To<a class="headerlink" href="#how-to" title="Permalink to this heading"></a></h1>
+<span id="howtos"></span><h1>How To<a class="headerlink" href="#how-to" title="Link to this heading"></a></h1>
 <p>This page shows short how to’s for the advanced usage.</p>
 <section id="tracking-non-robotic-objects">
-<h2>Tracking Non-Robotic Objects<a class="headerlink" href="#tracking-non-robotic-objects" title="Permalink to this heading"></a></h2>
+<h2>Tracking Non-Robotic Objects<a class="headerlink" href="#tracking-non-robotic-objects" title="Link to this heading"></a></h2>
 <p>In some cases it can be useful to provide the position or pose of rigid bodies in the motion capture space to the robots.
 For example, consider a collision avoidance algorithms implemented on-board the firmware that requires to know
 the position of an obstacle. In that case, a “virtual” robot can be defined in crazyflies.yaml</p>
@@ -112,7 +112,7 @@ <h2>Tracking Non-Robotic Objects<a class="headerlink" href="#tracking-non-roboti
 available via TF (named “obstacle”) and send to the firmware of the actual robots with id 255.</p>
 </section>
 <section id="debugging">
-<h2>Debugging<a class="headerlink" href="#debugging" title="Permalink to this heading"></a></h2>
+<h2>Debugging<a class="headerlink" href="#debugging" title="Link to this heading"></a></h2>
 <p>If there is a crash (e.g., segmentation fault) in the crazyflie_server (C++ backend), you can find the stacktrace by using gdb.
 First, compile your code in debug mode, then run the launch file with the debug flag, which will open an xterm window.
 If you don’t have xterm installed, you can do so using <cite>sudo apt install xterm</cite>.</p>

index.html

@@ -12,11 +12,11 @@
  <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
 
- <script src="_static/jquery.js"></script>
- <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
- <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
- <script src="_static/doctools.js"></script>
- <script src="_static/sphinx_highlight.js"></script>
+ <script src="_static/jquery.js?v=5d32c60e"></script>
+ <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+ <script src="_static/documentation_options.js?v=036e6a88"></script>
+ <script src="_static/doctools.js?v=888ff710"></script>
+ <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
  <script src="_static/js/theme.js"></script>
  <link rel="index" title="Index" href="genindex.html" />
  <link rel="search" title="Search" href="search.html" />
@@ -79,7 +79,7 @@
  <div itemprop="articleBody">
 
  <section id="crazyswarm2-a-ros-2-testbed-for-aerial-robot-teams">
-<span id="introduction"></span><h1>Crazyswarm2: A ROS 2 testbed for Aerial Robot Teams<a class="headerlink" href="#crazyswarm2-a-ros-2-testbed-for-aerial-robot-teams" title="Permalink to this heading"></a></h1>
+<span id="introduction"></span><h1>Crazyswarm2: A ROS 2 testbed for Aerial Robot Teams<a class="headerlink" href="#crazyswarm2-a-ros-2-testbed-for-aerial-robot-teams" title="Link to this heading"></a></h1>
 <p>Crazyswarm2 is a <strong>work-in-progress</strong> port of the original <a class="reference external" href="https://crazyswarm.readthedocs.io">Crazyswarm</a> to ROS 2.
 It is fully open-source and available on <a class="reference external" href="https://github.com/IMRCLab/crazyswarm2">github</a>.</p>
 <p>Crazyswarm2 is primarily made for researchers that want to operate or simulate a team of unmanned aerial vehicles (UAVs) that uses the
@@ -94,7 +94,7 @@
 </ul>
 </div>
 <section id="contents">
-<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
+<h2>Contents<a class="headerlink" href="#contents" title="Link to this heading"></a></h2>
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>

installation.html

@@ -12,11 +12,11 @@
  <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
 
- <script src="_static/jquery.js"></script>
- <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
- <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
- <script src="_static/doctools.js"></script>
- <script src="_static/sphinx_highlight.js"></script>
+ <script src="_static/jquery.js?v=5d32c60e"></script>
+ <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+ <script src="_static/documentation_options.js?v=036e6a88"></script>
+ <script src="_static/doctools.js?v=888ff710"></script>
+ <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
  <script src="_static/js/theme.js"></script>
  <link rel="index" title="Index" href="genindex.html" />
  <link rel="search" title="Search" href="search.html" />
@@ -84,7 +84,7 @@
  <div itemprop="articleBody">
 
  <section id="installation">
-<span id="id1"></span><h1>Installation<a class="headerlink" href="#installation" title="Permalink to this heading"></a></h1>
+<span id="id1"></span><h1>Installation<a class="headerlink" href="#installation" title="Link to this heading"></a></h1>
 <p>Crazyswarm2 runs on <strong>Ubuntu Linux</strong> in one of the following configurations:</p>
 <table class="docutils align-default">
 <tbody>
@@ -112,7 +112,7 @@
 <p>Avoid using a virtual machine if possible: they add additional latency and might cause issues with the visualization tools.</p>
 </div>
 <section id="first-installation">
-<h2>First Installation<a class="headerlink" href="#first-installation" title="Permalink to this heading"></a></h2>
+<h2>First Installation<a class="headerlink" href="#first-installation" title="Link to this heading"></a></h2>
 <ol class="arabic">
 <li><p>If needed, install ROS 2 using the instructions at <a class="reference external" href="https://docs.ros.org/en/galactic/Installation.html">https://docs.ros.org/en/galactic/Installation.html</a> or <a class="reference external" href="https://docs.ros.org/en/humble/Installation.html">https://docs.ros.org/en/humble/Installation.html</a>.</p></li>
 <li><p>Install dependencies</p>
@@ -166,7 +166,7 @@ <h2>First Installation<a class="headerlink" href="#first-installation" title="Pe
 </ol>
 </section>
 <section id="updating">
-<h2>Updating<a class="headerlink" href="#updating" title="Permalink to this heading"></a></h2>
+<h2>Updating<a class="headerlink" href="#updating" title="Link to this heading"></a></h2>
 <p>You can update your local copy using the following commands:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>ros2_ws/src/crazyswarm2
 git<span class="w"> </span>pull