Move Documentation to readthedocs

Right now all the documentation for this library is in README.md. It’s getting pretty unwieldy at this point, and should really probably be moved into a hosted page somewhere.

I’ve used readthedocs.org before, and it works pretty well. We’ll have to refactor the README documentation into sphinx documentation first, but that shouldn’t be too tricky.

Tasks:

• refactor documentation into a docs/ folder, using sphinx
• enable/connect readthedocs
• update README.md
  • to point to the hosted documentation
  • to only have a feature overview and basic quickstart
• (maybe) update repo description with the docs link

[ghost]

I would like to suggest MKDocs instead. It uses markdown instead of reStructuredText, and it’s lighter and easier to configure. — a bit like this library vs. Celery.

Another selling point is that it comes with a command to automatically build and push the result to the gh-pages branch, so it effectively publishes the documentation to GitHub pages (of course, you can build it and post it to another place.)

Example: https://jpscaletti.github.io/proper-form/

[sixhobbits]

Here’s a preview of what it could look like using MkDocs Material – a more modern theme of MkDocs that includes a lot of nice extras like search.