Sphinx docs

[moggers87]

The readme is a bit long IMO and setting up Sphinx as I have for exhibition and salmon shouldn't be too hard.

[sean0x42]

I think this project desperately needs some docs, or potentially even a clean up effort for the README. As someone new to the library, I found it quite difficult to figure everything out.

One thing that should be addressed in the new docs/README: How do you actually configure which backend is used? The README doesn't make it clear whether to use a string e.g.

SENDFILE_BACKEND = "sendfile.backend.nginx"

or to import some module...

from django_sendfile import sendfile
SENDFILE_BACKEND = sendfile.backend.nginx

Edit: Also, I think that installation instructions should be one of the first things users read.

Also also. Would really like some documentation on the parameters that the sendfile function takes.

[sean0x42]

Could also update the README so that each backend is listed as a link, and not given an entire section. Clicking that link takes you to a page in the GitHub wiki which describes exactly how to get up and running with that specific backend.

[moggers87]

The README is quite bad, it's still pretty much in the same shape it was when I forked this project.

[sean0x42]

So which way would you rather go @moggers87 ? Clean up README + Sphinx docs or Clean up README + GitHub wiki. I would happily lend a hand with either.

[moggers87]

Basic docs have been added in 383be13

If there's anything missing, open a PR 😉