Build the documentation

Install requirements

Building the Stable Gym documentation requires sphinx, the stable_gym python package and several plugins. All of the above can be installed using the following pip command inside the ./stable_gym folder:

pip install .[docs]

Build the documentation

To build the HTML documentation, go into the docs/ directory and run the make html command. This command will generate the html documentation inside the docs/build/html directory. If the documentation is successfully built, you can also use the make linkcheck command to check for broken links.

Attention

Make sure you are in the Conda environment in which you installed the stable_gym package with it’s dependencies.

Note

Sometimes the make linkcheck command doesn’t show the results on the stdout. You can also find the results in the docs/build/linkcheck folder.

Deploying

The documentation is automatically built and deployed to the Github Pages site by the Docs workflow when a new version is released. You must create a new release to deploy documentation to the Github Pages. Additionally, you can manually deploy the documentation through the GitHub action interface by running the Docs workflow.