search

bibanon / BASC-py4chan

Python wrapper for 4chan API. The BA's vastly improved fork of Edgeworth's original.
http://basc-py4chan.readthedocs.org/en/latest/index.html
Do What The F*ck You Want To Public License
55 stars 13 forks source link

Documentation! #1

Closed DanielOaks closed 8 years ago

DanielOaks commented 9 years ago

Just an issue to keep track of the documentation. I've setup a docs page with ReadTheDocs here, and it's progressing quite well.

I'm focusing more on the API side of things right now, but I'll flesh out the documentation proper and provide some good stuff for it.

Note: With the new documentation I've changed the docstring format to match Google's recommendation, because it looks and plays a lot nicer with Sphinx.

antonizoon commented 8 years ago

I now understand how to use the documentation, and it seems very good for anyone who wants to try it out.