Add modules documentation

flferretti · Oct 4, 2023 · afc98ad · afc98ad
1 parent 72ea6dd
commit afc98ad
Show file tree

Hide file tree

Showing 10 changed files with 74 additions and 57 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -5,8 +5,8 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = source
-BUILDDIR      = build
+SOURCEDIR     = .
+BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".
 help:

diff --git a/docs/guide/install.rst b/docs/guide/install.rst
@@ -0,0 +1,29 @@
+Installation
+============
+
+.. _installation:
+
+Prerequisites
+-------------
+
+JAXsim requires Python 3.10 or later. 
+
+Basic Installation
+------------
+
+You can install the project with `pypa/pip`, preferably in a `virtual environment`_:
+
+.. code-block:: bash
+
+   pip install jaxsim
+
+Have a look to `setup.cfg` for a complete list of optional dependencies.
+You can install all of them by specifying ``jaxsim[all]``.
+
+.. note::
+
+    If you need GPU support, please follow the official `installation instruction`_ of JAX.
+
+.. _pypa/pip: https://github.com/pypa/pip/
+.. _virtual environment: https://docs.python.org/3.8/tutorial/venv.html
+.. _installation instruction: https://github.com/google/jax/#installation
diff --git a/docs/modules/high_level.rst b/docs/modules/high_level.rst
@@ -0,0 +1,8 @@
+.. _high_level:
+
+
+High Level 
+==========
+
+.. automodule:: jaxsim.high_level
+    :members:
diff --git a/docs/modules/math.rst b/docs/modules/math.rst
@@ -0,0 +1,9 @@
+.. _math:
+
+
+Math 
+====
+
+.. automodule:: jaxsim.math
+    :members:
+
diff --git a/docs/modules/parsers.rst b/docs/modules/parsers.rst
@@ -0,0 +1,9 @@
+.. _parsers:
+
+
+Parsers 
+=======
+
+.. automodule:: jaxsim.parsers
+    :members:
+
diff --git a/docs/modules/physics.rst b/docs/modules/physics.rst
@@ -0,0 +1,9 @@
+.. _physics:
+
+
+Physics 
+=======
+
+.. automodule:: jaxsim.physics
+    :members:
+
diff --git a/docs/modules/simulation.rst b/docs/modules/simulation.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -15,8 +15,8 @@
 # -- Project information
 
 project = "JAXsim"
-copyright = "2022, Artifical and Mechanical Intelligence"
-author = "Artifical and Mechanical Intelligence"
+copyright = "2022, Artificial and Mechanical Intelligence"
+author = "Artificial and Mechanical Intelligence"
 
 release = "__version__"
 version = "main (" + __version__ + ")"
@@ -36,7 +36,11 @@
     "sphinx.ext.viewcode",
 ]
 
+# -- Options for intersphinx extension
+
+language = "en"
 templates_path = ["_templates"]
+master_doc = "index"
 
 # -- Options for HTML output
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -4,10 +4,10 @@ JAXsim
 A scalable physics engine implemented with JAX. With JIT batteries 🔋
 
 .. warning::
-   This project is still experimental, APIs could change without notice. ️⚠
+   This project is still experimental, APIs could change without notice. 
 
 .. warning::
-   This simulator currently focuses on locomotion applications. Only contacts with ground are supported. ️⚠
+   This simulator currently focuses on locomotion applications. Only contacts with ground are supported.
 
 Features
 --------
@@ -33,23 +33,6 @@ Planned features:
 
 .. _JAX: https://github.com/google/jax/
 
-Installation
-------------
-
-You can install the project with `pypa/pip`_, preferably in a `virtual environment`_:
-
-.. code-block:: bash
-
-   pip install jaxsim
-
-Have a look to `setup.cfg`_ for a complete list of optional dependencies.
-You can install all of them by specifying ``jaxsim[all]``.
-
-**Note:** if you need GPU support, please follow the official `installation instruction`_ of JAX.
-
-.. _pypa/pip: https://github.com/pypa/pip/
-.. _virtual environment: https://docs.python.org/3.8/tutorial/venv.html
-.. _installation instruction: https://github.com/google/jax/#installation
 
 Credits
 -------

diff --git a/docs/source/usage.rst b/docs/source/usage.rst