Skip to content

Commit 16a5931

Browse files
committed
Update documentation
1 parent 5fc31ee commit 16a5931

File tree

249 files changed

+8938
-8320
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

249 files changed

+8938
-8320
lines changed

2d_ellipse.html

Lines changed: 87 additions & 89 deletions
Large diffs are not rendered by default.

2d_line.html

Lines changed: 41 additions & 45 deletions
Large diffs are not rendered by default.

2d_linesegment.html

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
1+
2+
13
<!DOCTYPE html>
2-
<html class="writer-html5" lang="en" >
4+
<html class="writer-html5" lang="en">
35
<head>
4-
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
6+
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
57
<link rel="icon" sizes="16x16" href="_static/favicon-16x16.png" type="image/png">
68
<link rel="icon" sizes="32x32" href="_static/favicon-32x32.png" type="image/png">
79
<link rel="apple-touch-icon" sizes="180x180" href="_static/apple-touch-icon.png" type="image/png">
810
<link rel="android-chrome" sizes="192x192" href="_static/android-chrome-192x192.png" type="image/png">
911
<link rel="android-chrome" sizes="512x512" href="_static/android-chrome-512x512.png" type="image/png">
1012
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
1113
<title>2D line segment &mdash; Spatial Maths package documentation</title>
12-
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13-
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
14-
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
15-
<link rel="stylesheet" href="_static/plot_directive.css" type="text/css" />
16-
<!--[if lt IE 9]>
17-
<script src="_static/js/html5shiv.min.js"></script>
18-
<![endif]-->
14+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
15+
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
16+
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />
17+
<link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
18+
1919

20-
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
21-
<script src="_static/jquery.js"></script>
22-
<script src="_static/underscore.js"></script>
23-
<script src="_static/doctools.js"></script>
20+
<script src="_static/jquery.js?v=5d32c60e"></script>
21+
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
22+
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=b3ba4146"></script>
23+
<script src="_static/doctools.js?v=888ff710"></script>
24+
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
2425
<script src="_static/js/theme.js"></script>
2526
<link rel="index" title="Index" href="genindex.html" />
2627
<link rel="search" title="Search" href="search.html" />
@@ -40,9 +41,6 @@
4041
Spatial Maths package
4142
<img src="_static/CartesianSnakes_LogoW.png" class="logo" alt="Logo"/>
4243
</a>
43-
<div class="version">
44-
1.1.11
45-
</div>
4644
<div role="search">
4745
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
4846
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
@@ -102,7 +100,7 @@
102100
<div itemprop="articleBody">
103101

104102
<section id="d-line-segment">
105-
<h1>2D line segment<a class="headerlink" href="#d-line-segment" title="Permalink to this headline"></a></h1>
103+
<h1>2D line segment<a class="headerlink" href="#d-line-segment" title="Permalink to this heading"></a></h1>
106104
<dl class="py class">
107105
<dt class="sig sig-object py" id="spatialmath.geom2d.LineSegment2">
108106
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">LineSegment2</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/spatialmath/geom2d.html#LineSegment2"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#spatialmath.geom2d.LineSegment2" title="Permalink to this definition"></a></dt>
@@ -122,7 +120,7 @@ <h1>2D line segment<a class="headerlink" href="#d-line-segment" title="Permalink
122120

123121
<div role="contentinfo">
124122
<p>&#169; Copyright 2020-, Peter Corke..
125-
<span class="lastupdated">Last updated on 01-Aug-2024.
123+
<span class="lastupdated">Last updated on 30-Jan-2025.
126124
</span></p>
127125
</div>
128126

2d_orient_SO2.html

Lines changed: 195 additions & 306 deletions
Large diffs are not rendered by default.

2d_polygon.html

Lines changed: 78 additions & 82 deletions
Large diffs are not rendered by default.

2d_pose_SE2.html

Lines changed: 226 additions & 337 deletions
Large diffs are not rendered by default.

2d_pose_twist.html

Lines changed: 130 additions & 150 deletions
Large diffs are not rendered by default.

3d_dualquaternion.html

Lines changed: 47 additions & 53 deletions
Large diffs are not rendered by default.

3d_line.html

Lines changed: 201 additions & 243 deletions
Large diffs are not rendered by default.

3d_orient_SO3.html

Lines changed: 354 additions & 395 deletions
Large diffs are not rendered by default.

3d_orient_unitquaternion.html

Lines changed: 266 additions & 326 deletions
Large diffs are not rendered by default.

3d_plane.html

Lines changed: 53 additions & 55 deletions
Large diffs are not rendered by default.

3d_pose_SE3.html

Lines changed: 475 additions & 450 deletions
Large diffs are not rendered by default.

3d_pose_dualquaternion.html

Lines changed: 53 additions & 59 deletions
Large diffs are not rendered by default.

3d_pose_twist.html

Lines changed: 184 additions & 204 deletions
Large diffs are not rendered by default.

3d_quaternion.html

Lines changed: 148 additions & 212 deletions
Large diffs are not rendered by default.

6d_acceleration.html

Lines changed: 71 additions & 79 deletions
Large diffs are not rendered by default.

6d_f6.html

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
1+
2+
13
<!DOCTYPE html>
2-
<html class="writer-html5" lang="en" >
4+
<html class="writer-html5" lang="en">
35
<head>
4-
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
6+
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
57
<link rel="icon" sizes="16x16" href="_static/favicon-16x16.png" type="image/png">
68
<link rel="icon" sizes="32x32" href="_static/favicon-32x32.png" type="image/png">
79
<link rel="apple-touch-icon" sizes="180x180" href="_static/apple-touch-icon.png" type="image/png">
810
<link rel="android-chrome" sizes="192x192" href="_static/android-chrome-192x192.png" type="image/png">
911
<link rel="android-chrome" sizes="512x512" href="_static/android-chrome-512x512.png" type="image/png">
1012
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
1113
<title>Spatial F6 &mdash; Spatial Maths package documentation</title>
12-
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13-
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
14-
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
15-
<link rel="stylesheet" href="_static/plot_directive.css" type="text/css" />
16-
<!--[if lt IE 9]>
17-
<script src="_static/js/html5shiv.min.js"></script>
18-
<![endif]-->
14+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
15+
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
16+
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />
17+
<link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
18+
1919

20-
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
21-
<script src="_static/jquery.js"></script>
22-
<script src="_static/underscore.js"></script>
23-
<script src="_static/doctools.js"></script>
20+
<script src="_static/jquery.js?v=5d32c60e"></script>
21+
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
22+
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=b3ba4146"></script>
23+
<script src="_static/doctools.js?v=888ff710"></script>
24+
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
2425
<script src="_static/js/theme.js"></script>
2526
<link rel="index" title="Index" href="genindex.html" />
2627
<link rel="search" title="Search" href="search.html" />
@@ -40,9 +41,6 @@
4041
Spatial Maths package
4142
<img src="_static/CartesianSnakes_LogoW.png" class="logo" alt="Logo"/>
4243
</a>
43-
<div class="version">
44-
1.1.11
45-
</div>
4644
<div role="search">
4745
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
4846
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
@@ -108,18 +106,18 @@
108106
<div itemprop="articleBody">
109107

110108
<section id="spatial-f6">
111-
<h1>Spatial F6<a class="headerlink" href="#spatial-f6" title="Permalink to this headline"></a></h1>
109+
<h1>Spatial F6<a class="headerlink" href="#spatial-f6" title="Permalink to this heading"></a></h1>
112110
<dl class="py class">
113111
<dt class="sig sig-object py" id="spatialmath.spatialvector.SpatialF6">
114112
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">SpatialF6</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/spatialmath/spatialvector.html#SpatialF6"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#spatialmath.spatialvector.SpatialF6" title="Permalink to this definition"></a></dt>
115-
<dd><p>Bases: <a class="reference internal" href="6d_spatial.html#spatialmath.spatialvector.SpatialVector" title="spatialmath.spatialvector.SpatialVector"><code class="xref py py-class docutils literal notranslate"><span class="pre">spatialmath.spatialvector.SpatialVector</span></code></a></p>
113+
<dd><p>Bases: <a class="reference internal" href="6d_spatial.html#spatialmath.spatialvector.SpatialVector" title="spatialmath.spatialvector.SpatialVector"><code class="xref py py-class docutils literal notranslate"><span class="pre">SpatialVector</span></code></a></p>
116114
<p>Spatial 6-vector abstract force superclass</p>
117115
<p>Abstract superclass that represents the vector space for spatial force.</p>
118116
<dl class="field-list simple">
119-
<dt class="field-odd">Seealso</dt>
117+
<dt class="field-odd">Seealso<span class="colon">:</span></dt>
120118
<dd class="field-odd"><p><a class="reference internal" href="6d_force.html#spatialmath.spatialvector.SpatialForce" title="spatialmath.spatialvector.SpatialForce"><code class="xref py py-func docutils literal notranslate"><span class="pre">SpatialForce()</span></code></a>, <a class="reference internal" href="6d_momentum.html#spatialmath.spatialvector.SpatialMomentum" title="spatialmath.spatialvector.SpatialMomentum"><code class="xref py py-func docutils literal notranslate"><span class="pre">SpatialMomentum()</span></code></a>.</p>
121119
</dd>
122-
<dt class="field-even">Exclude-members</dt>
120+
<dt class="field-even">Exclude-members<span class="colon">:</span></dt>
123121
<dd class="field-even"><p>count, copy, index, sort, remove, binop, unop, arghandler</p>
124122
</dd>
125123
</dl>
@@ -144,7 +142,7 @@ <h1>Spatial F6<a class="headerlink" href="#spatial-f6" title="Permalink to this
144142

145143
<div role="contentinfo">
146144
<p>&#169; Copyright 2020-, Peter Corke..
147-
<span class="lastupdated">Last updated on 01-Aug-2024.
145+
<span class="lastupdated">Last updated on 30-Jan-2025.
148146
</span></p>
149147
</div>
150148

0 commit comments

Comments
 (0)