Gymnasium-docs¶

此文件夹包含 Gymnasium 的文档。

修改环境页面的说明¶

分叉 Gymnasium 并编辑环境中 Python 文件内的文档字符串。然后，通过 pip 安装你的 Gymnasium 分叉，并在此仓库中运行 docs/_scripts/gen_mds.py。这将自动为环境生成一个 Markdown 文档文件。

确保环境在 Gymnasium（或你的分叉）中。确保环境的 Python 文件有一个格式正确的 markdown 文档字符串。使用 pip install -e . 安装，然后运行 docs/_scripts/gen_mds.py。这将自动为环境生成一个 md 页面。然后完成其他步骤。

将相应的 gif 图像添加到 docs/_static/videos/{ENV_TYPE} 文件夹，其中 ENV_TYPE 是你的新环境的类别（例如 mujoco）。请遵循 snake_case 命名约定。或者，运行 docs/_scripts/gen_gifs.py。
编辑 docs/environments/{ENV_TYPE}/index.md，并将与你的新环境对应的文件名添加到 toctree 中。

安装所需的包和 Gymnasium（或你的分叉）

pip install gymnasium
pip install -r docs/requirements.txt

一次性构建文档

cd docs
make dirhtml

每次更改时自动重建文档

cd docs
sphinx-autobuild -b dirhtml --watch ../gymnasium --re-ignore "pickle$" . _build

然后你可以在浏览器中打开 https://:8000 查看文档的实时更新版本。

我们使用 Sphinx-Gallery 在 docs/tutorials 目录中构建教程。查看 docs/tutorials/demo.py 以了解教程示例，并参阅 Sphinx-Gallery 文档获取更多信息。

要将 Jupyter Notebook 转换为 Python 教程，你可以使用此脚本。

如果你希望 Sphinx-Gallery 执行教程（这将添加输出和图表），则文件名应以 run_ 开头。请注意，这将增加构建时间，因此请确保脚本的执行时间不超过几秒。