Skip to content

Commit 6efb8c1

Browse files
kaatrasakaatrasa
committed
Update docs for release 1.40
1 parent 3df4119 commit 6efb8c1

28 files changed

+2651
-1904
lines changed

‎sdk/_static/basic.css

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,10 @@ a.headerlink {
237237
visibility: hidden;
238238
}
239239

240+
a:visited {
241+
color: #551A8B;
242+
}
243+
240244
h1:hover > a.headerlink,
241245
h2:hover > a.headerlink,
242246
h3:hover > a.headerlink,

‎sdk/_static/documentation_options.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
var DOCUMENTATION_OPTIONS = {
2-
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
1+
const DOCUMENTATION_OPTIONS = {
32
VERSION: '',
43
LANGUAGE: 'en',
54
COLLAPSE_INDEX: false,

‎sdk/_static/pygments.css

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -6,70 +6,70 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
66
.highlight .hll { background-color: #ffffcc }
77
.highlight { background: #eeffcc; }
88
.highlight .c { color: #408090; font-style: italic } /* Comment */
9-
.highlight .err { border: 1px solid #F00 } /* Error */
9+
.highlight .err { border: 1px solid #FF0000 } /* Error */
1010
.highlight .k { color: #007020; font-weight: bold } /* Keyword */
11-
.highlight .o { color: #666 } /* Operator */
11+
.highlight .o { color: #666666 } /* Operator */
1212
.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */
1313
.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
1414
.highlight .cp { color: #007020 } /* Comment.Preproc */
1515
.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */
1616
.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
17-
.highlight .cs { color: #408090; background-color: #FFF0F0 } /* Comment.Special */
17+
.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
1818
.highlight .gd { color: #A00000 } /* Generic.Deleted */
1919
.highlight .ge { font-style: italic } /* Generic.Emph */
2020
.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
21-
.highlight .gr { color: #F00 } /* Generic.Error */
21+
.highlight .gr { color: #FF0000 } /* Generic.Error */
2222
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
2323
.highlight .gi { color: #00A000 } /* Generic.Inserted */
24-
.highlight .go { color: #333 } /* Generic.Output */
25-
.highlight .gp { color: #C65D09; font-weight: bold } /* Generic.Prompt */
24+
.highlight .go { color: #333333 } /* Generic.Output */
25+
.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
2626
.highlight .gs { font-weight: bold } /* Generic.Strong */
2727
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
28-
.highlight .gt { color: #04D } /* Generic.Traceback */
28+
.highlight .gt { color: #0044DD } /* Generic.Traceback */
2929
.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
3030
.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
3131
.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
3232
.highlight .kp { color: #007020 } /* Keyword.Pseudo */
3333
.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
3434
.highlight .kt { color: #902000 } /* Keyword.Type */
3535
.highlight .m { color: #208050 } /* Literal.Number */
36-
.highlight .s { color: #4070A0 } /* Literal.String */
37-
.highlight .na { color: #4070A0 } /* Name.Attribute */
36+
.highlight .s { color: #4070a0 } /* Literal.String */
37+
.highlight .na { color: #4070a0 } /* Name.Attribute */
3838
.highlight .nb { color: #007020 } /* Name.Builtin */
39-
.highlight .nc { color: #0E84B5; font-weight: bold } /* Name.Class */
40-
.highlight .no { color: #60ADD5 } /* Name.Constant */
41-
.highlight .nd { color: #555; font-weight: bold } /* Name.Decorator */
42-
.highlight .ni { color: #D55537; font-weight: bold } /* Name.Entity */
39+
.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
40+
.highlight .no { color: #60add5 } /* Name.Constant */
41+
.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
42+
.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
4343
.highlight .ne { color: #007020 } /* Name.Exception */
44-
.highlight .nf { color: #06287E } /* Name.Function */
44+
.highlight .nf { color: #06287e } /* Name.Function */
4545
.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
46-
.highlight .nn { color: #0E84B5; font-weight: bold } /* Name.Namespace */
46+
.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
4747
.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
48-
.highlight .nv { color: #BB60D5 } /* Name.Variable */
48+
.highlight .nv { color: #bb60d5 } /* Name.Variable */
4949
.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
50-
.highlight .w { color: #BBB } /* Text.Whitespace */
50+
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
5151
.highlight .mb { color: #208050 } /* Literal.Number.Bin */
5252
.highlight .mf { color: #208050 } /* Literal.Number.Float */
5353
.highlight .mh { color: #208050 } /* Literal.Number.Hex */
5454
.highlight .mi { color: #208050 } /* Literal.Number.Integer */
5555
.highlight .mo { color: #208050 } /* Literal.Number.Oct */
56-
.highlight .sa { color: #4070A0 } /* Literal.String.Affix */
57-
.highlight .sb { color: #4070A0 } /* Literal.String.Backtick */
58-
.highlight .sc { color: #4070A0 } /* Literal.String.Char */
59-
.highlight .dl { color: #4070A0 } /* Literal.String.Delimiter */
60-
.highlight .sd { color: #4070A0; font-style: italic } /* Literal.String.Doc */
61-
.highlight .s2 { color: #4070A0 } /* Literal.String.Double */
62-
.highlight .se { color: #4070A0; font-weight: bold } /* Literal.String.Escape */
63-
.highlight .sh { color: #4070A0 } /* Literal.String.Heredoc */
64-
.highlight .si { color: #70A0D0; font-style: italic } /* Literal.String.Interpol */
65-
.highlight .sx { color: #C65D09 } /* Literal.String.Other */
56+
.highlight .sa { color: #4070a0 } /* Literal.String.Affix */
57+
.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
58+
.highlight .sc { color: #4070a0 } /* Literal.String.Char */
59+
.highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */
60+
.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
61+
.highlight .s2 { color: #4070a0 } /* Literal.String.Double */
62+
.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
63+
.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
64+
.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
65+
.highlight .sx { color: #c65d09 } /* Literal.String.Other */
6666
.highlight .sr { color: #235388 } /* Literal.String.Regex */
67-
.highlight .s1 { color: #4070A0 } /* Literal.String.Single */
67+
.highlight .s1 { color: #4070a0 } /* Literal.String.Single */
6868
.highlight .ss { color: #517918 } /* Literal.String.Symbol */
6969
.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
70-
.highlight .fm { color: #06287E } /* Name.Function.Magic */
71-
.highlight .vc { color: #BB60D5 } /* Name.Variable.Class */
72-
.highlight .vg { color: #BB60D5 } /* Name.Variable.Global */
73-
.highlight .vi { color: #BB60D5 } /* Name.Variable.Instance */
74-
.highlight .vm { color: #BB60D5 } /* Name.Variable.Magic */
70+
.highlight .fm { color: #06287e } /* Name.Function.Magic */
71+
.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
72+
.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
73+
.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
74+
.highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */
7575
.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */

‎sdk/_static/searchtools.js

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,12 @@ const _removeChildren = (element) => {
5757
const _escapeRegExp = (string) =>
5858
string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
5959

60-
const _displayItem = (item, searchTerms) => {
60+
const _displayItem = (item, searchTerms, highlightTerms) => {
6161
const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
62-
const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT;
6362
const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
6463
const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
6564
const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
65+
const contentRoot = document.documentElement.dataset.content_root;
6666

6767
const [docName, title, anchor, descr, score, _filename] = item;
6868

@@ -75,20 +75,24 @@ const _displayItem = (item, searchTerms) => {
7575
if (dirname.match(/\/index\/$/))
7676
dirname = dirname.substring(0, dirname.length - 6);
7777
else if (dirname === "index/") dirname = "";
78-
requestUrl = docUrlRoot + dirname;
78+
requestUrl = contentRoot + dirname;
7979
linkUrl = requestUrl;
8080
} else {
8181
// normal html builders
82-
requestUrl = docUrlRoot + docName + docFileSuffix;
82+
requestUrl = contentRoot + docName + docFileSuffix;
8383
linkUrl = docName + docLinkSuffix;
8484
}
8585
let linkEl = listItem.appendChild(document.createElement("a"));
8686
linkEl.href = linkUrl + anchor;
8787
linkEl.dataset.score = score;
8888
linkEl.innerHTML = title;
89-
if (descr)
89+
if (descr) {
9090
listItem.appendChild(document.createElement("span")).innerHTML =
9191
" (" + descr + ")";
92+
// highlight search terms in the description
93+
if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
94+
highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
95+
}
9296
else if (showSearchSummary)
9397
fetch(requestUrl)
9498
.then((responseData) => responseData.text())
@@ -97,6 +101,9 @@ const _displayItem = (item, searchTerms) => {
97101
listItem.appendChild(
98102
Search.makeSearchSummary(data, searchTerms)
99103
);
104+
// highlight search terms in the summary
105+
if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
106+
highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
100107
});
101108
Search.output.appendChild(listItem);
102109
};
@@ -115,14 +122,15 @@ const _finishSearch = (resultCount) => {
115122
const _displayNextItem = (
116123
results,
117124
resultCount,
118-
searchTerms
125+
searchTerms,
126+
highlightTerms,
119127
) => {
120128
// results left, load the summary and display it
121129
// this is intended to be dynamic (don't sub resultsCount)
122130
if (results.length) {
123-
_displayItem(results.pop(), searchTerms);
131+
_displayItem(results.pop(), searchTerms, highlightTerms);
124132
setTimeout(
125-
() => _displayNextItem(results, resultCount, searchTerms),
133+
() => _displayNextItem(results, resultCount, searchTerms, highlightTerms),
126134
5
127135
);
128136
}
@@ -360,7 +368,7 @@ const Search = {
360368
// console.info("search results:", Search.lastresults);
361369

362370
// print the results
363-
_displayNextItem(results, results.length, searchTerms);
371+
_displayNextItem(results, results.length, searchTerms, highlightTerms);
364372
},
365373

366374
/**

‎sdk/_static/sphinx_highlight.js

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,19 @@ const _highlight = (node, addItems, text, className) => {
2929
}
3030

3131
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
32+
const rest = document.createTextNode(val.substr(pos + text.length));
3233
parent.insertBefore(
3334
span,
3435
parent.insertBefore(
35-
document.createTextNode(val.substr(pos + text.length)),
36+
rest,
3637
node.nextSibling
3738
)
3839
);
3940
node.nodeValue = val.substr(0, pos);
41+
/* There may be more occurrences of search term in this node. So call this
42+
* function recursively on the remaining fragment.
43+
*/
44+
_highlight(rest, addItems, text, className);
4045

4146
if (isInSVG) {
4247
const rect = document.createElementNS(
@@ -140,5 +145,10 @@ const SphinxHighlight = {
140145
},
141146
};
142147

143-
_ready(SphinxHighlight.highlightSearchWords);
144-
_ready(SphinxHighlight.initEscapeListener);
148+
_ready(() => {
149+
/* Do not call highlightSearchWords() when we are on the search page.
150+
* It will highlight words from the *previous* search query.
151+
*/
152+
if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords();
153+
SphinxHighlight.initEscapeListener();
154+
});

‎sdk/api.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE html>
2-
<html class="writer-html5" lang="en">
2+
<html class="writer-html5" lang="en" data-content_root="./">
33
<head>
44
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
77
<title>API Reference &mdash; spectacularAI documentation</title>
8-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
8+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
99
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
1010
<link rel="stylesheet" type="text/css" href="_static/tabs.css?v=a5c4661c" />
1111
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=3a41478c" />
@@ -18,9 +18,9 @@
1818

1919
<script src="_static/jquery.js?v=5d32c60e"></script>
2020
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
21-
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=b3ba4146"></script>
21+
<script src="_static/documentation_options.js?v=5929fcd5"></script>
2222
<script src="_static/doctools.js?v=888ff710"></script>
23-
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
23+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
2424
<script src="_static/js/theme.js"></script>
2525
<link rel="index" title="Index" href="genindex.html" />
2626
<link rel="search" title="Search" href="search.html" />
@@ -94,7 +94,7 @@
9494
<li><a href="index.html" aria-label="Home">Spectacular AI SDK documentation</a></li>
9595
<li class="breadcrumb-item active">API Reference</li>
9696
<li class="wy-breadcrumbs-aside version">
97-
v1.39
97+
v1.40
9898
</li>
9999
</ul>
100100

@@ -104,10 +104,10 @@
104104
<div itemprop="articleBody">
105105

106106
<section id="api-reference">
107-
<h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this heading"></a></h1>
107+
<h1>API Reference<a class="headerlink" href="#api-reference" title="Link to this heading"></a></h1>
108108
<p>Full API reference on a single page</p>
109109
<section id="latest-version">
110-
<h2>Latest version<a class="headerlink" href="#latest-version" title="Permalink to this heading"></a></h2>
110+
<h2>Latest version<a class="headerlink" href="#latest-version" title="Link to this heading"></a></h2>
111111
<div class="toctree-wrapper compound">
112112
<ul>
113113
<li class="toctree-l1"><a class="reference internal" href="python/latest/index.html">Python</a></li>

‎sdk/core.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE html>
2-
<html class="writer-html5" lang="en">
2+
<html class="writer-html5" lang="en" data-content_root="./">
33
<head>
44
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
77
<title>Core SDK &mdash; spectacularAI documentation</title>
8-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
8+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
99
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
1010
<link rel="stylesheet" type="text/css" href="_static/tabs.css?v=a5c4661c" />
1111
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=3a41478c" />
@@ -18,9 +18,9 @@
1818

1919
<script src="_static/jquery.js?v=5d32c60e"></script>
2020
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
21-
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=b3ba4146"></script>
21+
<script src="_static/documentation_options.js?v=5929fcd5"></script>
2222
<script src="_static/doctools.js?v=888ff710"></script>
23-
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
23+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
2424
<script src="_static/js/theme.js"></script>
2525
<link rel="index" title="Index" href="genindex.html" />
2626
<link rel="search" title="Search" href="search.html" />
@@ -94,7 +94,7 @@
9494
<li><a href="index.html" aria-label="Home">Spectacular AI SDK documentation</a></li>
9595
<li class="breadcrumb-item active">Core SDK</li>
9696
<li class="wy-breadcrumbs-aside version">
97-
v1.39
97+
v1.40
9898
</li>
9999
</ul>
100100

@@ -104,7 +104,7 @@
104104
<div itemprop="articleBody">
105105

106106
<section id="core-sdk">
107-
<span id="id1"></span><h1>Core SDK<a class="headerlink" href="#core-sdk" title="Permalink to this heading"></a></h1>
107+
<span id="id1"></span><h1>Core SDK<a class="headerlink" href="#core-sdk" title="Link to this heading"></a></h1>
108108
<p>The Spectacular AI Core SDK is a platform-independent software solution for real-time 3D mapping and
109109
6-DoF pose tracking. The core SDK includes the following public modules, which can be used with any device supported by the SDK.</p>
110110
<div class="toctree-wrapper compound">

0 commit comments

Comments
 (0)