From 0b574274dfb49cbabeb1234ae6593275f3a0f0b2 Mon Sep 17 00:00:00 2001 From: Dominik Roth Date: Tue, 5 Dec 2023 18:15:07 +0100 Subject: [PATCH] Pull examples into generated docs --- docs/source/examples/dmc.rst | 6 ++++++ docs/source/examples/general.rst | 6 ++++++ docs/source/examples/metaworld.rst | 6 ++++++ docs/source/examples/movement_primitives.rst | 6 ++++++ docs/source/examples/mp_params_tuning.rst | 6 ++++++ docs/source/examples/open_ai.rst | 6 ++++++ docs/source/examples/pd_control_gain_tuning.rst | 6 ++++++ docs/source/examples/replanning_envs.rst | 6 ++++++ 8 files changed, 48 insertions(+) create mode 100644 docs/source/examples/dmc.rst create mode 100644 docs/source/examples/general.rst create mode 100644 docs/source/examples/metaworld.rst create mode 100644 docs/source/examples/movement_primitives.rst create mode 100644 docs/source/examples/mp_params_tuning.rst create mode 100644 docs/source/examples/open_ai.rst create mode 100644 docs/source/examples/pd_control_gain_tuning.rst create mode 100644 docs/source/examples/replanning_envs.rst diff --git a/docs/source/examples/dmc.rst b/docs/source/examples/dmc.rst new file mode 100644 index 0000000..692feeb --- /dev/null +++ b/docs/source/examples/dmc.rst @@ -0,0 +1,6 @@ +DeepMind Control Examples +========================= + +.. literalinclude:: ../../../fancy_gym/examples/examples_dmc.py + :language: python + :linenos: \ No newline at end of file diff --git a/docs/source/examples/general.rst b/docs/source/examples/general.rst new file mode 100644 index 0000000..3636b60 --- /dev/null +++ b/docs/source/examples/general.rst @@ -0,0 +1,6 @@ +General Usage Examples +====================== + +.. literalinclude:: ../../../fancy_gym/examples/examples_general.py + :language: python + :linenos: \ No newline at end of file diff --git a/docs/source/examples/metaworld.rst b/docs/source/examples/metaworld.rst new file mode 100644 index 0000000..5ee8067 --- /dev/null +++ b/docs/source/examples/metaworld.rst @@ -0,0 +1,6 @@ +Metaworld Examples +================== + +.. literalinclude:: ../../../fancy_gym/examples/examples_metaworld.py + :language: python + :linenos: \ No newline at end of file diff --git a/docs/source/examples/movement_primitives.rst b/docs/source/examples/movement_primitives.rst new file mode 100644 index 0000000..279ea55 --- /dev/null +++ b/docs/source/examples/movement_primitives.rst @@ -0,0 +1,6 @@ +Movement Primitives Examples +============================ + +.. literalinclude:: ../../../fancy_gym/examples/examples_movement_primitives.py + :language: python + :linenos: \ No newline at end of file diff --git a/docs/source/examples/mp_params_tuning.rst b/docs/source/examples/mp_params_tuning.rst new file mode 100644 index 0000000..8defd74 --- /dev/null +++ b/docs/source/examples/mp_params_tuning.rst @@ -0,0 +1,6 @@ +MP Params Tuning Example +======================== + +.. literalinclude:: ../../../fancy_gym/examples/mp_params_tuning.py + :language: python + :linenos: \ No newline at end of file diff --git a/docs/source/examples/open_ai.rst b/docs/source/examples/open_ai.rst new file mode 100644 index 0000000..d386fbe --- /dev/null +++ b/docs/source/examples/open_ai.rst @@ -0,0 +1,6 @@ +OpenAI Envs Examples +==================== + +.. literalinclude:: ../../../fancy_gym/examples/examples_open_ai.py + :language: python + :linenos: \ No newline at end of file diff --git a/docs/source/examples/pd_control_gain_tuning.rst b/docs/source/examples/pd_control_gain_tuning.rst new file mode 100644 index 0000000..b5ea973 --- /dev/null +++ b/docs/source/examples/pd_control_gain_tuning.rst @@ -0,0 +1,6 @@ +PD Control Gain Tuning Example +============================== + +.. literalinclude:: ../../../fancy_gym/examples/pd_control_gain_tuning.py + :language: python + :linenos: \ No newline at end of file diff --git a/docs/source/examples/replanning_envs.rst b/docs/source/examples/replanning_envs.rst new file mode 100644 index 0000000..2b1cc06 --- /dev/null +++ b/docs/source/examples/replanning_envs.rst @@ -0,0 +1,6 @@ +Replanning Example +================== + +.. literalinclude:: ../../../fancy_gym/examples/example_replanning_envs.py + :language: python + :linenos: \ No newline at end of file