Install docs
bkjones opened this issue · comments
Trying to get started with this module is made exponentially more difficult by the install document which, depending on the step you're on, is either really incomplete, or incorrect (out of date? Not clear, but the changelog on readthedocs says the latest release is 4.0.2, so maybe the rest of the docs are from then as well?). I wonder if maybe you have some automated process that's supposed to push doc updates to readthedocs that might be silently failing?
For just a couple of quick examples:
- the apparently required configuration setting, CYBERSOURCE_REDIRECT_PENDING, is missing from my settings, because it's completely missing from the install doc
- the way that the urlpattern is being defined in the doc doesn't work. It should probably be
path('api/cybersource/', include(apps.get_app_config('cybersource').urls[0]))
which I found by digging around in the sandbox app. - Even the
pip install
command fails to mention that your package is in pypi, opting instead for a hard-coded gitlab url which, by the way, looks like it might be hard-coded for release 1.0.0.