docs api reference

Author: jakegrigsby

.github/workflows/gh-pages.yml

@@ -26,7 +26,6 @@ jobs:
         run: |
           pip install --upgrade pip
           pip install -e .
-          pip install -e .[envs]
 
       - name: Install docs dependencies
         run: |

docs/installation.rst

@@ -17,7 +17,7 @@ There are some optional installs for additional features:
 
 - ``pip install -e amago[mamba]``: Enables `Mamba <https://arxiv.org/abs/2312.00752>`_ sequence model policies.
 
-- ``pip install -e amago[envs]``: AMAGO comes with built-in support for a wide range of existing and custom meta-RL/generalization/memory domains (``amago/envs/builtin``) used in our experiments. This command installs (most of) the dependencies you'd need to run the `examples/ <examples/>`_.
+- ``pip install -e amago[envs]``: AMAGO comes with built-in support for a wide range of existing and custom meta-RL/generalization/memory domains (:py:mod:`amago.envs.builtin`) used in our experiments. This command installs (most of) the dependencies you'd need to run the `examples/ <examples/>`_.
 
 .. note::
 

docs/tutorial/configuration.rst

@@ -191,4 +191,4 @@ If we want to combine hardcoded changes like these with genuine ``.gin`` files,
     You can view your active gin config (all the active hyperparameters used by an experiment) in the checkpoint directory as ``config.txt``, or on ``wandb`` in the ``Config`` section.
 
 
-A full API reference is available in the :doc:`/api/amago` section.
+A full API reference is available in the :doc:`API Reference </api/amago>` section.

docs/tutorial/index.rst

@@ -4,7 +4,7 @@ Tutorial
 |
 
 Applying AMAGO to any new problem involves wrapping the environment, defining the network architecture, creating a dataset, 
-and configuring the experiment. The :doc:`/examples/` include helpful starting points for common cases.
+and configuring the experiment. The :doc:` examples </examples/index>` include helpful starting points for common cases.
 
 .. image:: ../media/amago_overview.png
    :alt: amagoarch