More details for readme

[dimon222]

Fix #50
Does it make sense to also convert it to markdown? Currently still RST

[kevin-bates]

LGTM

[kevin-bates]

I prefer markdown over rst so I like that idea. Did you want to do that as part of this change - or wait on that?

[dimon222]

@kevin-bates I'll convert to markdown shortly.

[kevin-bates]

Just the one comment. Everything else looks good, but we'll know more once that back-quotes are fixed.

EDIT: The build is failing because setup.py pulls the long description from README.rst.

[dimon222]

@kevin-bates if u could provide the details on error for docs build failure (I believe its only visible for people with higher ownership in this repo), maybe we could cover it in this PR as well, as it anyway somewhat part of documentation piece.

I mean this badge:

[kevin-bates]

ok - I'll try to take a look. That stuff is a bit of mystery to me.

[kevin-bates]

@dimon222 - looks like @toidi is the sole maintainer. The last build was the failure nearly two years ago. I can't really see anything apparently wrong. https://readthedocs.org/projects/python-client-for-hadoop-yarn-api/builds/6260674/

Since these have been failing for some time and we need more access/information, I think we should move on.

[kevin-bates]

LGTM - thanks. We'll address the 20 month-old doc build issues later.

[dimon222]

@kevin-bates I agree. Btw, I'm able to run build from my own fork without issues. I think github token that was used for Oauth to pull repo is no longer valid. If you or @lresende could request/register on readthedocs (maybe it can inherit access permissions from anyone who has access to change repository), it might refresh that Oauth token and start generating docs correctly.

The main problem is that new documentation is not being generated, so people might get confused by incompatible API signatures (since we significantly changed it since then)

[kevin-bates]

Given the docs build locally for you, I'm going ahead with the merge. Thank you!