~petersanchez/django-impersonate#50: 
Add proper and readable documentation

Despite it looks like the README is quite extensive it is difficult to read it in bitbucket. I propose the following enhancement:

  • Add proper docs separating the content of the README into separate pages,
  • Put those docs in a platform like Read the Docs,
  • Reduce the length of the README to provide some quick introduction and then redirect to docs on Read The Docs.

Doing so it will allow to indicate in https://djangopackages.org/grids/g/user-switching/ that this app does indeed have docs.

Status
REPORTED
Submitter
bitbucket:Leandro Regueiro
Assigned to
No-one
Submitted
6 years ago
Updated
4 years ago
Labels
Task

bitbucket:Peter Sanchez 6 years ago ยท edit

Thank you for this ticket! This is something that's been on the back burner forever. It's been super tough finding the time but this is a good reminder.

~petersanchez added Task 4 years ago

Register here or Log in to comment, or comment via email.