gaspersic/Gymnasium
1
0
Fork 0
mirror of https://github.com/Farama-Foundation/Gymnasium.git synced 2025-08-22 07:02:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Small fixes to docs (#724)

Browse Source
This commit is contained in:
Manuel Goulão
2023-09-25 13:56:30 +01:00
committed by GitHub
parent baf78078c3
commit 3e7ae6f5c9
5 changed files with 186 additions and 186 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/build-docs.yml vendored
View File

@@ -21,7 +21,7 @@ jobs:
run: pip install -r docs/requirements.txt run: pip install -r docs/requirements.txt
- name: Install Gymnasium - name: Install Gymnasium
run: pip install .[box2d,mujoco] run: pip install .[box2d,mujoco,jax] torch
- name: Build Envs Docs - name: Build Envs Docs
run: python docs/_scripts/gen_mds.py && python docs/_scripts/gen_envs_display.py run: python docs/_scripts/gen_mds.py && python docs/_scripts/gen_envs_display.py

2
.github/workflows/docs-manual-versioning.yml vendored
View File

@@ -37,7 +37,7 @@ jobs:
run: pip install -r docs/requirements.txt run: pip install -r docs/requirements.txt
- name: Install Gymnasium - name: Install Gymnasium
run: pip install .[box2d,mujoco] run: pip install .[box2d,mujoco,jax] torch
- name: Build Envs Docs - name: Build Envs Docs
run: python docs/_scripts/gen_mds.py && python docs/_scripts/gen_envs_display.py run: python docs/_scripts/gen_mds.py && python docs/_scripts/gen_envs_display.py

2
.github/workflows/docs-versioning.yml vendored
View File

@@ -22,7 +22,7 @@ jobs:
run: pip install -r docs/requirements.txt run: pip install -r docs/requirements.txt
- name: Install Gymnasium - name: Install Gymnasium
run: pip install .[box2d,mujoco] run: pip install .[box2d,mujoco,jax] torch
- name: Build Envs Docs - name: Build Envs Docs
run: python docs/_scripts/gen_mds.py && python docs/_scripts/gen_envs_display.py run: python docs/_scripts/gen_mds.py && python docs/_scripts/gen_envs_display.py

24
docs/api/experimental/functional.md
View File

@@ -7,23 +7,23 @@ title: Functional
## gymnasium.experimental.FuncEnv ## gymnasium.experimental.FuncEnv
```{eval-rst} ```{eval-rst}
.. autoclass:: gymnasium.experimental.FuncEnv .. autoclass:: gymnasium.experimental.functional.FuncEnv
.. autofunction:: gymnasium.experimental.FuncEnv.initial .. autofunction:: gymnasium.experimental.functional.FuncEnv.initial
.. autofunction:: gymnasium.experimental.FuncEnv.transition .. autofunction:: gymnasium.experimental.functional.FuncEnv.transition
.. autofunction:: gymnasium.experimental.FuncEnv.observation .. autofunction:: gymnasium.experimental.functional.FuncEnv.observation
.. autofunction:: gymnasium.experimental.FuncEnv.reward .. autofunction:: gymnasium.experimental.functional.FuncEnv.reward
.. autofunction:: gymnasium.experimental.FuncEnv.terminal .. autofunction:: gymnasium.experimental.functional.FuncEnv.terminal
.. autofunction:: gymnasium.experimental.FuncEnv.state_info .. autofunction:: gymnasium.experimental.functional.FuncEnv.state_info
.. autofunction:: gymnasium.experimental.FuncEnv.step_info .. autofunction:: gymnasium.experimental.functional.FuncEnv.step_info
.. autofunction:: gymnasium.experimental.FuncEnv.transform .. autofunction:: gymnasium.experimental.functional.FuncEnv.transform
.. autofunction:: gymnasium.experimental.FuncEnv.render_image .. autofunction:: gymnasium.experimental.functional.FuncEnv.render_image
.. autofunction:: gymnasium.experimental.FuncEnv.render_init .. autofunction:: gymnasium.experimental.functional.FuncEnv.render_init
.. autofunction:: gymnasium.experimental.FuncEnv.render_close .. autofunction:: gymnasium.experimental.functional.FuncEnv.render_close
``` ```
## gymnasium.experimental.func2env.FunctionalJaxCompatibilityEnv ## gymnasium.experimental.func2env.FunctionalJaxCompatibilityEnv

2
docs/requirements.txt
View File

@@ -1,7 +1,7 @@
sphinx sphinx
sphinx-autobuild sphinx-autobuild
myst-parser myst-parser
git+https://github.com/sphinx-gallery/sphinx-gallery.git@4006662c8c1984453a247dc6d3df6260e5b00f4b#egg=sphinx_gallery sphinx-gallery==0.14.0
git+https://github.com/Farama-Foundation/Celshast#egg=furo git+https://github.com/Farama-Foundation/Celshast#egg=furo
moviepy moviepy
pygame pygame