Skip to content

Commit 4625ee8

Browse files
committed
minor doc update
1 parent b59b606 commit 4625ee8

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

docs/source/conf.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@
4343
'sphinx.ext.doctest',
4444
'sphinx.ext.inheritance_diagram',
4545
'sphinx_autorun',
46+
"sphinx.ext.intersphinx",
4647
]
4748
#'sphinx-prompt',
4849
#'recommonmark',
@@ -159,3 +160,9 @@
159160
import numpy as np
160161
np.set_printoptions(precision=4, suppress=True)
161162
"""
163+
164+
intersphinx_mapping = {
165+
"numpy": ("http://docs.scipy.org/doc/numpy/", None),
166+
"scipy": ("http://docs.scipy.org/doc/scipy/reference/", None),
167+
"matplotlib": ("http://matplotlib.sourceforge.net/", None),
168+
}

docs/source/index.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,15 @@
66
Spatial Maths for Python
77
========================
88

9-
9+
10+
This package provides Python classes and functions to represent, print, plot,
11+
manipulate and covert between many common representations of position,
12+
orientation and pose of objects in 2D or 3D space. This includes
13+
mathematical objects such as rotation matrices :math:`\mat{R} \in \SO{2},
14+
\SO{3}`, angle sequences, exponential coordinates, homogeneous transformation matrices :math:`\mat{T} \in \SE{2}, \SE{3}`,
15+
unit quaternions :math:`\q \in \mathrm{S}^3`, and twists :math:`S \in \se{2},
16+
\se{3}`.
17+
1018
.. toctree::
1119
:maxdepth: 2
1220

0 commit comments

Comments
 (0)