Update documentation

JeanElsner · Nov 26, 2023 · b557f7c · b557f7c
1 parent 4056773
commit b557f7c
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -39,7 +39,7 @@
 
 redirects = {
     # index.rst just contains the table of contents definition.
-    'index': 'dm_robotics.panda.html',
+    'index': 'tutorial.html',
 }
 
 # -- Options for HTML output -------------------------------------------------

diff --git a/src/dm_robotics/panda/__init__.py b/src/dm_robotics/panda/__init__.py
@@ -1,3 +1,9 @@
 r'''
-A model of the Panda robot for `dm_robotics <https://github.com/deepmind/dm_robotics>`_.
+This is the API documentation of the ``dm_robotics_panda`` package.
+If you're looking for an introduction on how to use this package,
+please refer to the :doc:`tutorial`.
+
+As a user you will mostly interact with ``PandaEnvironment`` found
+in the :py:mod:`dm_robotics.panda.environment` module. Robots are
+configured with parameters defined in :py:mod:`dm_robotics.panda.parameters`.
 '''