Documentation should not ask you to add files into rlpy folders

Issue #44 resolved
cdann@cdann.de created an issue

The current make_*.rst tutorials ask you to put the files into the rlpy path. This path may not even be writable for the user, for example, if rlpy was installed via pip. Instead, the tutorials should distinguish two cases:

  1. write your own components for yourself, which is a standard use case of rlpy. In this case, the files can be generated wherever the user prefers.
  2. contribute to rlpy by adding a component. Should briefly talk about the header and the other requirements as well as how to install rlpy in developer mode (e.g. pip install or manually) and pull-requests as the preferred way of contributing code.

Comments (3)

  1. Log in to comment