Skip to content

Commit

Permalink
Add modules documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
flferretti committed Oct 4, 2023
1 parent e4be873 commit ac03484
Show file tree
Hide file tree
Showing 10 changed files with 74 additions and 57 deletions.
4 changes: 2 additions & 2 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
29 changes: 29 additions & 0 deletions docs/guide/install.rst
Original file line number Diff line number Diff line change
@@ -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
8 changes: 8 additions & 0 deletions docs/modules/high_level.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _high_level:


High Level
==========

.. automodule:: jaxsim.high_level
:members:
9 changes: 9 additions & 0 deletions docs/modules/math.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _math:


Math
====

.. automodule:: jaxsim.math
:members:

9 changes: 9 additions & 0 deletions docs/modules/parsers.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _parsers:


Parsers
=======

.. automodule:: jaxsim.parsers
:members:

9 changes: 9 additions & 0 deletions docs/modules/physics.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _physics:


Physics
=======

.. automodule:: jaxsim.physics
:members:

Empty file added docs/modules/simulation.rst
Empty file.
8 changes: 6 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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__ + ")"
Expand All @@ -36,7 +36,11 @@
"sphinx.ext.viewcode",
]

# -- Options for intersphinx extension

language = "en"
templates_path = ["_templates"]
master_doc = "index"

# -- Options for HTML output

Expand Down
21 changes: 2 additions & 19 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------
Expand All @@ -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
-------
Expand Down
34 changes: 0 additions & 34 deletions docs/source/usage.rst

This file was deleted.

0 comments on commit ac03484

Please sign in to comment.