Documentation Fixes - Githubissues

icaros-usc / pyribs

A bare-bones Python library for quality diversity optimization.

https://pyribs.org

MIT License

208 stars 32 forks source link

Documentation Fixes #315

Closed btjanaka closed 1 year ago

btjanaka commented 1 year ago

Description

Miscellaneous docs fixes, including errors thrown by sphinx and comments suggested by @robbycostales.

TODO

[x] Add contributing link in README
[x] Fix README links in documentation -- myst parser would previously say "reference target not found" because we had not generated links for header anchors automatically
[x] Fix list formatting error in EvolutionStrategyBase docstring
[x] Add links to list of pyribs tutorials so users can easily figure out order of tutorials

Questions

Status

[x] I have read the guidelines in CONTRIBUTING.md
[x] I have formatted my code using yapf
[x] I have tested my code by running pytest
[x] I have linted my code with pylint
[ ] ~I have added a one-line description of my change to the changelog in HISTORY.md~
[x] This PR is ready to go