icaros-usc / pyribs

A bare-bones Python library for quality diversity optimization.
https://pyribs.org
MIT License
208 stars 32 forks source link

Remove README from docs exclude patterns as it does not help #317

Closed btjanaka closed 1 year ago

btjanaka commented 1 year ago

Description

We keep getting warnings like:

...../docs/tutorials/README.md: WARNING: document isn't included in any toctree

because README.md is in docs/tutorials due to symlinking but we do not want it in the documentation. We tried to change this in #316 but the warning still shows up. Since it does not break the build, we will leave this warning as is.

TODO

Questions

Status