tanliyon / gym-xiangqi

This repo sets up the environment to play Xiang Qi (chinese chess) following the OpenAI Gym framework.

GNU Lesser General Public License v3.0

32 stars 6 forks source link

Update API documentation #83

Closed hojoungjang closed 3 years ago

hojoungjang commented 3 years ago

Description

Update XiangQiEnv docstrings and inline comments
Add utils functions to API documentation

Type of change

[ ] Bug fix (non-breaking changes which fixes an issue)
[ ] New feature (non-breaking changes which adds certain functionality)
[x] Documentation update (updating documentations)
[] Breaking change (fix that breaks existing functionality)

How has this been tested?

ReadTheDocs build: https://gym-xiangqi.readthedocs.io/en/api_doc/