diff --git a/docs/conf.py b/docs/conf.py index 7182bd72e..6d28c1690 100644 --- 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 index b39c51904..74b44c05e 100644 --- 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 index 4fcb3e53f..01f721fa8 100644 --- 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 `_ 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 index 1c512d2a1..1254abc3e 100644 --- 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: \ No newline at end of file diff --git a/docs/modules/math.rst b/docs/modules/math.rst index 5097f3e5d..45221ef87 100644 --- 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: \ No newline at end of file diff --git a/docs/modules/parsers.rst b/docs/modules/parsers.rst index aad6824e2..d1a34045f 100644 --- 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: \ No newline at end of file diff --git a/docs/modules/physics.rst b/docs/modules/physics.rst index dab6999da..71fbf3597 100644 --- 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: \ No newline at end of file diff --git a/docs/modules/simulation.rst b/docs/modules/simulation.rst index 819c34c9a..a2718d7d0 100644 --- 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 index 8c125ae3d..303cd831b 100644 --- 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: \ No newline at end of file diff --git a/docs/modules/utils.rst b/docs/modules/utils.rst index 1a105f0d4..269f5f53d 100644 --- 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: \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt index 7db1f079a..c8c99a321 100644 --- 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