Merge pull request #403 from iory/docs

[docs] Fixed readthedocs by using python3.11's sphinx
iory · Oct 29, 2024 · 4284a09 · 4284a09
2 parents a602eae + 21cf34a
commit 4284a09
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 59 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -41,7 +41,7 @@ jobs:
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v4
       with:
-        python-version: 3.8
+        python-version: 3.11
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip

diff --git a/docs/source/reference/functions.rst b/docs/source/reference/functions.rst
@@ -10,34 +10,34 @@ Utilities functions
    :toctree: generated/
    :nosignatures:
 
-   skrobot.coordinates.math.convert_to_axis_vector
-   skrobot.coordinates.math._check_valid_rotation
-   skrobot.coordinates.math._check_valid_translation
-   skrobot.coordinates.math.triple_product
-   skrobot.coordinates.math.inverse_rodrigues
-   skrobot.coordinates.math.rotation_angle
-   skrobot.coordinates.math.make_matrix
-   skrobot.coordinates.math.random_rotation
-   skrobot.coordinates.math.random_translation
-   skrobot.coordinates.math.midpoint
-   skrobot.coordinates.math.midrot
-   skrobot.coordinates.math.transform
-   skrobot.coordinates.math.rotation_matrix
-   skrobot.coordinates.math.rotate_vector
-   skrobot.coordinates.math.rotate_matrix
-   skrobot.coordinates.math.rpy_matrix
-   skrobot.coordinates.math.rpy_angle
-   skrobot.coordinates.math.normalize_vector
-   skrobot.coordinates.math.matrix_log
-   skrobot.coordinates.math.matrix_exponent
-   skrobot.coordinates.math.outer_product_matrix
-   skrobot.coordinates.math.rotation_matrix_from_rpy
-   skrobot.coordinates.math.rotation_matrix_from_axis
-   skrobot.coordinates.math.rodrigues
-   skrobot.coordinates.math.rotation_angle
-   skrobot.coordinates.math.rotation_distance
-   skrobot.coordinates.math.axis_angle_from_matrix
-   skrobot.coordinates.math.angle_between_vectors
+   convert_to_axis_vector
+   _check_valid_rotation
+   _check_valid_translation
+   triple_product
+   inverse_rodrigues
+   rotation_angle
+   make_matrix
+   random_rotation
+   random_translation
+   midpoint
+   midrot
+   transform
+   rotation_matrix
+   rotate_vector
+   rotate_matrix
+   rpy_matrix
+   rpy_angle
+   normalize_vector
+   matrix_log
+   matrix_exponent
+   outer_product_matrix
+   rotation_matrix_from_rpy
+   rotation_matrix_from_axis
+   rodrigues
+   rotation_angle
+   rotation_distance
+   axis_angle_from_matrix
+   angle_between_vectors
 
 
 Jacobian Functions
@@ -47,9 +47,9 @@ Jacobian Functions
    :toctree: generated/
    :nosignatures:
 
-   skrobot.coordinates.math.sr_inverse
-   skrobot.coordinates.math.sr_inverse_org
-   skrobot.coordinates.math.manipulability
+   sr_inverse
+   sr_inverse_org
+   manipulability
 
 
 Quaternion Functions
@@ -59,27 +59,27 @@ Quaternion Functions
    :toctree: generated/
    :nosignatures:
 
-   skrobot.coordinates.math.xyzw2wxyz
-   skrobot.coordinates.math.wxyz2xyzw
-   skrobot.coordinates.math.random_quaternion
-   skrobot.coordinates.math.quaternion_multiply
-   skrobot.coordinates.math.quaternion_conjugate
-   skrobot.coordinates.math.quaternion_inverse
-   skrobot.coordinates.math.quaternion_slerp
-   skrobot.coordinates.math.quaternion_distance
-   skrobot.coordinates.math.quaternion_absolute_distance
-   skrobot.coordinates.math.quaternion_norm
-   skrobot.coordinates.math.quaternion_normalize
-   skrobot.coordinates.math.matrix2quaternion
-   skrobot.coordinates.math.quaternion2matrix
-   skrobot.coordinates.math.quaternion2rpy
-   skrobot.coordinates.math.rpy2quaternion
-   skrobot.coordinates.math.rpy_from_quat
-   skrobot.coordinates.math.quat_from_rotation_matrix
-   skrobot.coordinates.math.quat_from_rpy
-   skrobot.coordinates.math.rotation_matrix_from_quat
-   skrobot.coordinates.math.quaternion_from_axis_angle
-   skrobot.coordinates.math.axis_angle_from_quaternion
+   xyzw2wxyz
+   wxyz2xyzw
+   random_quaternion
+   quaternion_multiply
+   quaternion_conjugate
+   quaternion_inverse
+   quaternion_slerp
+   quaternion_distance
+   quaternion_absolute_distance
+   quaternion_norm
+   quaternion_normalize
+   matrix2quaternion
+   quaternion2matrix
+   quaternion2rpy
+   rpy2quaternion
+   rpy_from_quat
+   quat_from_rotation_matrix
+   quat_from_rpy
+   rotation_matrix_from_quat
+   quaternion_from_axis_angle
+   axis_angle_from_quaternion
 
 
 .. module:: skrobot.coordinates.geo
@@ -91,4 +91,4 @@ Geometry functions
    :toctree: generated/
    :nosignatures:
 
-   skrobot.coordinates.geo.rotate_points
+   rotate_points
diff --git a/docs/source/reference/interfaces.rst b/docs/source/reference/interfaces.rst
@@ -13,7 +13,7 @@ You can use a Pybullet interface using skrobot.
    :toctree: generated/
    :nosignatures:
 
-   skrobot.interfaces._pybullet.PybulletRobotInterface
+   PybulletRobotInterface
 
 >>> from skrobot.models import PR2
 >>> from skrobot.interfaces import PybulletRobotInterface

diff --git a/docs/source/reference/models.rst b/docs/source/reference/models.rst
@@ -11,7 +11,7 @@ Robot Model class
    :toctree: generated/
    :nosignatures:
 
-   skrobot.model.RobotModel
+   RobotModel
 
 
 Robot Model classes
@@ -28,7 +28,7 @@ Fetch
    :toctree: generated/
    :nosignatures:
 
-   skrobot.models.fetch.Fetch
+   fetch.Fetch
 
 .. figure:: ../../image/fetch.png
     :scale: 40%
@@ -42,7 +42,7 @@ Kuka
    :toctree: generated/
    :nosignatures:
 
-   skrobot.models.kuka.Kuka
+   kuka.Kuka
 
 .. figure:: ../../image/kuka.png
     :scale: 40%
@@ -55,7 +55,7 @@ PR2
    :toctree: generated/
    :nosignatures:
 
-   skrobot.models.pr2.PR2
+   pr2.PR2
 
 .. figure:: ../../image/pr2.png
     :scale: 40%