Pygithub: Where is the documentation???

Created on 23 Oct 2016  ·  13Comments  ·  Source: PyGithub/PyGithub

Where is the Documentation for the library??

All 13 comments

Where are the documentation files? I couldn't find them in /doc: https://github.com/PyGithub/PyGithub/tree/master/doc. They need an update, and I would gladly make a PR if they were available

@ericbrandwein The documentation detail are in the code itself: https://github.com/PyGithub/PyGithub/blob/master/github/Commit.py#L159-L166

@MichaelPereira oh great, then the documentation on ReadTheDocs needs an update, because the "edit on github" button sends me to the /doc directory in this repo 😕

Which is fine because this is where the introduction, table of contents, etc are located, but the location of the code documentation could be made a little more explicit

Would be nice if the README contained a link to the docs.

@gvanrossum There you go.

2016-11-01 19-35-43

Hidden in plain sight. :-(

That's the problem when you have too many badges. I think docs is a bit more important than a badge, so this should definitely be expanded on more in the readme.

In addition to the README, it would be nicer if the link to the doc is added here:
url_here

IMHO @gvanrossum and @tmshn are spot on.
In fact, the description in the readme.md could be nothing more than the link to the correct docs.(because the current description contains only links to super well-known sources.
@jzelinskie , if you have the access, Please approve @gamefiend 's https://github.com/PyGithub/PyGithub/pull/499

Closed by #499

Was this page helpful?
0 / 5 - 0 ratings