Add support for python doc files without rst gallery (#770)

Co-authored-by: Mark Towers <mark.m.towers@gmail.com>

docs/conf.py

@@ -16,6 +16,7 @@ import re
 import sys
 
 import sphinx_gallery.gen_rst
+from furo.gen_tutorials import generate_tutorials
 
 
 # Path setup for building from source tree
@@ -138,6 +139,12 @@ sphinx_gallery_conf = {
     ),
 }
 
+# All tutorials in the tutorials directory will be generated automatically
+# by sphinx-gallery.
+# However, we also want to generate some tutorials without the gallery
+# and to a more specific location so we use this custom function.
+generate_tutorials("introduction/*.py", "./introduction")
+
 # -- Generate Changelog -------------------------------------------------
 
 sphinx_github_changelog_token = os.environ.get("SPHINX_GITHUB_CHANGELOG_TOKEN")

docs/index.md

@@ -1,96 +1,96 @@
----
+---
-hide-toc: true
+hide-toc: true
-firstpage:
+firstpage:
-lastpage:
+lastpage:
----
+---
-
+
-```{project-logo} _static/img/gymnasium-text.png
+```{project-logo} _static/img/gymnasium-text.png
-:alt: Gymnasium Logo
+:alt: Gymnasium Logo
-```
+```
-
+
-```{project-heading}
+```{project-heading}
-An API standard for reinforcement learning with a diverse collection of reference environments
+An API standard for reinforcement learning with a diverse collection of reference environments
-```
+```
-
+
-```{figure} _static/videos/box2d/lunar_lander.gif
+```{figure} _static/videos/box2d/lunar_lander.gif
-   :alt: Lunar Lander
+   :alt: Lunar Lander
-   :width: 500
+   :width: 500
-```
+```
-
+
-**Gymnasium is a maintained fork of OpenAI’s Gym library.** The Gymnasium interface is simple, pythonic, and capable of representing general RL problems, and has a [compatibility wrapper](introduction/gym_compatibility) for old Gym environments:
+**Gymnasium is a maintained fork of OpenAI’s Gym library.** The Gymnasium interface is simple, pythonic, and capable of representing general RL problems, and has a [compatibility wrapper](introduction/gym_compatibility) for old Gym environments:
-
+
-```{code-block} python
+```{code-block} python
-import gymnasium as gym
+import gymnasium as gym
-
+
-# Initialise the environment
+# Initialise the environment
-env = gym.make("LunarLander-v2", render_mode="human")
+env = gym.make("LunarLander-v2", render_mode="human")
-
+
-# Reset the environment to generate the first observation
+# Reset the environment to generate the first observation
-observation, info = env.reset(seed=42)
+observation, info = env.reset(seed=42)
-for _ in range(1000):
+for _ in range(1000):
-    # this is where you would insert your policy
+    # this is where you would insert your policy
-    action = env.action_space.sample()
+    action = env.action_space.sample()
-
+
-    # step (transition) through the environment with the action
+    # step (transition) through the environment with the action
-    # receiving the next observation, reward and if the episode has terminated or truncated
+    # receiving the next observation, reward and if the episode has terminated or truncated
-    observation, reward, terminated, truncated, info = env.step(action)
+    observation, reward, terminated, truncated, info = env.step(action)
-
+
-    # If the episode has ended then we can reset to start a new episode
+    # If the episode has ended then we can reset to start a new episode
-    if terminated or truncated:
+    if terminated or truncated:
-        observation, info = env.reset()
+        observation, info = env.reset()
-
+
-env.close()
+env.close()
-```
+```
-
+
-```{toctree}
+```{toctree}
-:hidden:
+:hidden:
-:caption: Introduction
+:caption: Introduction
-
+
-introduction/basic_usage
+introduction/basic_usage
-introduction/gym_compatibility
+introduction/gym_compatibility
-introduction/migration-guide
+introduction/migration-guide
-```
+```
-
+
-```{toctree}
+```{toctree}
-:hidden:
+:hidden:
-:caption: API
+:caption: API
-
+
-api/env
+api/env
-api/registry
+api/registry
-api/spaces
+api/spaces
-api/wrappers
+api/wrappers
-api/vector
+api/vector
-api/utils
+api/utils
-api/functional
+api/functional
-```
+```
-
+
-```{toctree}
+```{toctree}
-:hidden:
+:hidden:
-:caption: Environments
+:caption: Environments
-
+
-environments/classic_control
+environments/classic_control
-environments/box2d
+environments/box2d
-environments/toy_text
+environments/toy_text
-environments/mujoco
+environments/mujoco
-environments/atari
+environments/atari
-environments/third_party_environments
+environments/third_party_environments
-```
+```
-
+
-```{toctree}
+```{toctree}
-:hidden:
+:hidden:
-:glob:
+:glob:
-:caption: Tutorials
+:caption: Tutorials
-
+
-tutorials/**/index
+tutorials/**/index
-Comet Tutorial <https://www.comet.com/docs/v2/integrations/ml-frameworks/gymnasium/?utm_source=gymnasium&utm_medium=partner&utm_campaign=partner_gymnasium_2023&utm_content=docs_gymnasium>
+Comet Tutorial <https://www.comet.com/docs/v2/integrations/ml-frameworks/gymnasium/?utm_source=gymnasium&utm_medium=partner&utm_campaign=partner_gymnasium_2023&utm_content=docs_gymnasium>
-```
+```
-
+
-```{toctree}
+```{toctree}
-:hidden:
+:hidden:
-:caption: Development
+:caption: Development
-
+
-Github <https://github.com/Farama-Foundation/Gymnasium>
+Github <https://github.com/Farama-Foundation/Gymnasium>
-gymnasium_release_notes/index
+gymnasium_release_notes/index
-gym_release_notes/index
+gym_release_notes/index
-Contribute to the Docs <https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md>
+Contribute to the Docs <https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md>
-```
+```