Fix import errors in docs

flferretti · Oct 4, 2023 · ffa9d45 · ffa9d45
1 parent fc09a7c
commit ffa9d45
Show file tree

Hide file tree

Showing 11 changed files with 15 additions and 14 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -4,7 +4,7 @@
 
 # -- Version information
 
-sys.path.insert(0, pathlib.Path(__file__).parents[2].absolute())
+sys.path.insert(0, pathlib.Path(__file__).parents[3].absolute())
 version_file = (
     pathlib.Path(__file__).parents[1].absolute() / "src" / "jaxsim" / "version.txt"
 )

diff --git a/docs/guide/install.rst b/docs/guide/install.rst
@@ -9,7 +9,7 @@ Prerequisites
 JAXsim requires Python 3.10 or later. 
 
 Basic Installation
-------------
+------------------
 
 You can install the project with `pypa/pip`, preferably in a `virtual environment`_:
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -12,7 +12,7 @@ A scalable physics engine implemented with JAX. With JIT batteries 🔋
 Features
 --------
 
-- Physics engine in reduced coordinates implemented with `JAX`_ in Python.
+- Physics engine in reduced coordinates implemented with `JAX <https://github.com/google/jax>`_ in Python.
 - Supported JIT compilation of Python code for increased performance.
 - Transparent support to execute the simulation on CPUs, GPUs, and TPUs.
 - Possibility to run parallel multi-body simulations on hardware accelerators for significantly increased throughput.

diff --git a/docs/modules/high_level.rst b/docs/modules/high_level.rst
@@ -4,6 +4,6 @@
 High Level 
 ==========
 
-.. automodule:: src.jaxsim.high_level
+.. automodule:: jaxsim.high_level
     :members:
     :inherited-members:
diff --git a/docs/modules/math.rst b/docs/modules/math.rst
@@ -4,6 +4,6 @@
 Math 
 ====
 
-.. automodule:: src.jaxsim.math
+.. automodule:: jaxsim.math
     :members:
     :inherited-members:
diff --git a/docs/modules/parsers.rst b/docs/modules/parsers.rst
@@ -4,6 +4,6 @@
 Parsers 
 =======
 
-.. automodule:: src.jaxsim.parsers
+.. automodule:: jaxsim.parsers
     :members:
     :inherited-members:
diff --git a/docs/modules/physics.rst b/docs/modules/physics.rst
@@ -4,6 +4,6 @@
 Physics 
 =======
 
-.. automodule:: src.jaxsim.physics
+.. automodule:: jaxsim.physics
     :members:
     :inherited-members:
diff --git a/docs/modules/simulation.rst b/docs/modules/simulation.rst
@@ -4,12 +4,12 @@
 Simulation 
 ==========
 
-.. automodule:: src.jaxsim.simulation
+.. automodule:: jaxsim.simulation
 
-.. autoclass:: src.jaxsim.simulation.SimulatorData
+.. autoclass:: jaxsim.simulation.SimulatorData
     :members:
     :inherited-members:
 
-.. autoclass:: src.jaxsim.simulation.JaxSim
+.. autoclass:: jaxsim.simulation.JaxSim
 :members:
 :inherited-members:
diff --git a/docs/modules/sixd.rst b/docs/modules/sixd.rst
@@ -2,8 +2,8 @@
 
 
 SixD 
-==========
+====
 
-.. automodule:: src.jaxsim.sixd
+.. automodule:: jaxsim.sixd
     :members:
     :inherited-members:
diff --git a/docs/modules/utils.rst b/docs/modules/utils.rst
@@ -2,8 +2,8 @@
 
 
 Utils 
-==========
+=====
 
-.. automodule:: src.jaxsim.utils
+.. automodule:: jaxsim.utils
     :members:
     :inherited-members:
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,4 @@
+jaxsim
 sphinx==7.1.2
 sphinx-rtd-theme==1.3.0rc1
 sphinx_autodoc_typehints
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,7 +9,7 @@ Prerequisites @@
     JAXsim requires Python 3.10 or later.
     Basic Installation
-    ------------
+    ------------------
     You can install the project with `pypa/pip`, preferably in a `virtual environment`_:
@@ Expand Down @@