Farama-Foundation / Minigrid

Simple and easily configurable grid world environments for reinforcement learning
https://minigrid.farama.org/
Other
2.05k stars 597 forks source link

[Bug Report] Docu link to `minigrid/core/constants.py` broken #431

Open turbotimon opened 2 months ago

turbotimon commented 2 months ago

Describe the bug

In many environment pages, there is this sentence, but the link is broken.

OBJECT_TO_IDX and COLOR_TO_IDX mapping can be found in minigrid/core/constants.py

e.g. here: https://minigrid.farama.org/main/environments/minigrid/DoorKeyEnv/#observation-encoding

Possible should point directly to gitub? https://github.com/Farama-Foundation/Minigrid/blob/master/minigrid/core/constants.py

Checklist

pseudo-rnd-thoughts commented 2 months ago

Could you make a PR to fix this

turbotimon commented 2 months ago

Happy to do so, however need some help to get started as i'm not (yet) familiar with sphinx..

I think it would be best if the /minigrid/core/constants.py would also be rendered under https://minigrid.farama.org/_modules/ so we can directly link to it (and to the right release version). I don't think link it directly to github is a good idea..

If that is not possible, I would change the text like this (italic is new):

What do you think?

pseudo-rnd-thoughts commented 1 month ago

Apologies for not originally replying, yes this is a good idea