Clean up docs

dfki-ric · Sep 10, 2024 · b6c2d70 · b6c2d70
1 parent e2317f8
commit b6c2d70
Show file tree

Hide file tree

Showing 13 changed files with 32 additions and 73 deletions.
diff --git a/doc/source/api.rst b/doc/source/api.rst
@@ -42,8 +42,8 @@ Conversions
 Conversions to Rotation Matrix
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-See also :doc:`euler_angles` for conversions from and to Euler angles
-that have been omitted here for the sake of brevity.
+See also :doc:`user_guide/euler_angles` for conversions from and to Euler
+angles that have been omitted here for the sake of brevity.
 
 .. autosummary::
  :toctree: _apidoc/

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -60,14 +60,11 @@
  "logo": {
  "text": f"pytransform3d {release}"
  },
- "navbar_links": [
- ("Contents", "index"),
- ("Examples", "_auto_examples/index"),
- ("API", "api"),
- ],
+ "sidebarwidth": 100,
+ "collapse_navigation": True
 }
 html_sidebars = {
- "**": [],
+  "install": []
 }
 html_static_path = ['_static']
 html_last_updated_fmt = '%b %d, %Y'

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -1,53 +1,18 @@
 .. pytransform3d documentation master file, created by
  sphinx-quickstart on Thu Nov 20 21:01:30 2014.
 
-.. raw:: html
-
- <div class="text-right">
-
 =============
 pytransform3d
 =============
 
-.. raw:: html
-
- </div>
-
- <div class="container-fluid">
- <div class="row">
-
- <div class="col-md-4">
- <div class="panel panel-default">
- <div class="panel-heading">
- <h3 class="panel-title">Contents</h3>
- </div>
- <div class="panel-body">
-
 .. toctree::
- :maxdepth: 1
+ :hidden:
 
  install
- user_guide/introduction
- user_guide/rotations
- user_guide/transformations
- user_guide/transformation_ambiguities
- user_guide/euler_angles
- user_guide/transformation_modeling
- user_guide/transform_manager
- user_guide/transformation_over_time
- user_guide/camera
- user_guide/animations
+ user_guide/index
  api
  _auto_examples/index
 
-.. raw:: html
-
- </div>
- </div>
- </div>
-
- <div class="col-md-8">
-
 This documentation explains how you can work with pytransform3d and with
 3D transformations in general.
 
@@ -97,11 +62,3 @@ Journal of Open Source Software, 4(33), 1159, |DOI|_
 
 .. |DOI| image:: http://joss.theoj.org/papers/10.21105/joss.01159/status.svg
 .. _DOI: https://doi.org/10.21105/joss.01159
-
-.. raw:: html
-
- </div>
-
- </div>
- </div>
-
diff --git a/doc/source/user_guide/euler_angles.rst b/doc/source/user_guide/euler_angles.rst
@@ -10,9 +10,6 @@ conventions that could be used. Furthermore, you have to find out whether
 degrees or radians are used to express the angles (we will only use
 radians in pytransform3d).
 
-.. contents:: :local:
- :depth: 1
-
 -------
 Example
 -------

diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst
@@ -0,0 +1,17 @@
+==========
+User Guide
+==========
+
+.. toctree::
+ :maxdepth: 1
+
+ introduction
+ rotations
+ transformations
+ transformation_ambiguities
+ euler_angles
+ transformation_modeling
+ transform_manager
+ transformation_over_time
+ camera
+ animations
diff --git a/doc/source/user_guide/rotations.rst b/doc/source/user_guide/rotations.rst
@@ -10,13 +10,10 @@ is non-redundant, continuous, and free of singularities. We will now take a
 closer look at competing representations of rotations and the orientations they
 can describe.
 
-.. contents:: :local:
- :depth: 1
-
 Here is an overview of the representations and the conversions between them
 that are available in pytransform3d.
 
-.. image:: _static/rotations.png
+.. image:: ../_static/rotations.png
  :alt: Rotations
  :width: 50%
  :align: center

diff --git a/doc/source/user_guide/transformations.rst b/doc/source/user_guide/transformations.rst
@@ -8,9 +8,6 @@ Transformations consist of a rotation and a translation. Those can be
 represented in different ways just like rotations can be expressed
 in different ways.
 
-.. contents:: :local:
- :depth: 1
-
 For most representations of orientations we can find
 an analogous representation of transformations [1]_:
 
@@ -37,7 +34,7 @@ an analogous representation of transformations [1]_:
 Here is an overview of the representations and the conversions between them
 that are available in pytransform3d.
 
-.. image:: _static/transformations.png
+.. image:: ../_static/transformations.png
  :alt: Transformations
  :width: 50%
  :align: center
@@ -149,7 +146,7 @@ along the screw axis and rotates about it.
 pytransform3d uses two vectors q and `s_axis` of shape (3,) and a scalar
 h to represent the parameters of a screw.
 
-.. image:: _static/screw_axis.png
+.. image:: ../_static/screw_axis.png
  :alt: Screw axis
  :width: 50%
  :align: center

diff --git a/examples/README.rst b/examples/README.rst
@@ -3,6 +3,3 @@ Examples
 ========
 
 The following examples show how pytransform3d can be used.
-
-.. contents:: :local:
- :depth: 1
diff --git a/pytransform3d/camera.py b/pytransform3d/camera.py
@@ -1,6 +1,6 @@
 """Transformations related to cameras.
 
-See :doc:`camera` for more information.
+See :doc:`user_guide/camera` for more information.
 """
 import numpy as np
 from .transformations import (invert_transform, transform, check_transform,

diff --git a/pytransform3d/rotations/__init__.py b/pytransform3d/rotations/__init__.py
@@ -1,6 +1,6 @@
 """Rotations in three dimensions - SO(3).
 
-See :doc:`rotations` for more information.
+See :doc:`user_guide/rotations` for more information.
 """
 from ._constants import (
  eps, unitx, unity, unitz, q_i, q_j, q_k, q_id, a_id, R_id, p0)

diff --git a/pytransform3d/transform_manager/__init__.py b/pytransform3d/transform_manager/__init__.py
@@ -1,6 +1,6 @@
 """Manage complex chains of transformations.
 
-See :doc:`transform_manager` for more information.
+See :doc:`user_guide/transform_manager` for more information.
 """
 from ._transform_graph_base import TransformGraphBase
 from ._transform_manager import TransformManager

diff --git a/pytransform3d/transformations/__init__.py b/pytransform3d/transformations/__init__.py
@@ -1,6 +1,6 @@
 """Transformations in three dimensions - SE(3).
 
-See :doc:`transformations` for more information.
+See :doc:`user_guide/transformations` for more information.
 """
 from ._utils import (
  check_transform, check_pq, check_screw_parameters, check_screw_axis,

diff --git a/pytransform3d/urdf.py b/pytransform3d/urdf.py
@@ -1,6 +1,6 @@
 """Load transformations from URDF files.
 
-See :doc:`transform_manager` for more information.
+See :doc:`user_guide/transform_manager` for more information.
 """
 import os
 import numpy as np