Add documentation about ember-django-adapter HOT 5 CLOSED

Just happened to see this. DRF uses MkDocs and it is recommended in the DRF third party plugin cookie cutter project.

from ember-django-adapter.

I was thinking that a website instead of the wiki pages would make the documentation easier to find. I have a preference for github pages because Sphinx and RTD seem Python specific. But this is just a guess because I haven't used Sphinx and RTD in non-Python projects.

Mkdocs seems to work with gh pages and has some pre-built themes but doesn't have docstring extraction. Here's a discussion I found:
https://www.reddit.com/r/Python/comments/2268hd/mkdocs_a_fast_and_simple_static_site_generator/

Github pages can also generated pages and has pre-built themes. It seems to use markdown as well but again doesn't have docstring extraction. The gh pages themes seem more polished but also easy for every project to use (i.e. not unique). There's some info here:
https://pages.github.com/

@dustinfarris Having the docstrings in the documentation doesn't seem important to me because it's mostly covered in the ED documentation itself. I think we should be looking for something that's easy and automatic. A custom theme / logo would be nice but I'd rather spend the extra time I have on getting everything working well.

I propose that we use mkdocs with the 'Read the Docs' theme. We can always make a custom theme in the future if we want. This is not a strong preference; I'm really just picking something so we can move forward. Feel free to pick another option. :)

from ember-django-adapter.

That sounds great to me. I'll work on it over the weekend.

from ember-django-adapter.

@g-cassie Forgot to give you a shout out for suggesting mkdocs. Thanks for that!

from ember-django-adapter.

See #39

from ember-django-adapter.