Begin docs
[ci skip]
This commit is contained in:
parent
ec2bd7d686
commit
55641a1966
72 changed files with 26300 additions and 1 deletions
43
docs/api.rst
Normal file
43
docs/api.rst
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
.. _api:
|
||||
|
||||
Developer Interface
|
||||
===================
|
||||
|
||||
.. module:: twython
|
||||
|
||||
This page of the documentation will cover all methods and classes available to the developer.
|
||||
|
||||
Twython, currently, has two main interfaces:
|
||||
|
||||
- Twitter's Core API (updating statuses, getting timelines, direct messaging, etc)
|
||||
- Twitter's Streaming API
|
||||
|
||||
Core Interface
|
||||
--------------
|
||||
|
||||
.. autoclass:: Twython
|
||||
:special-members: __init__
|
||||
:inherited-members:
|
||||
|
||||
Streaming Interface
|
||||
-------------------
|
||||
|
||||
.. autoclass:: TwythonStreamer
|
||||
:special-members: __init__
|
||||
:inherited-members:
|
||||
|
||||
Streaming Types
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
.. autoclass:: twython.streaming.types.TwythonStreamerTypes
|
||||
:inherited-members:
|
||||
|
||||
.. autoclass:: twython.streaming.types.TwythonStreamerTypesStatuses
|
||||
:inherited-members:
|
||||
|
||||
Exceptions
|
||||
----------
|
||||
|
||||
.. autoexception:: TwythonError
|
||||
.. autoexception:: TwythonAuthError
|
||||
.. autoexception:: TwythonRateLimitError
|
||||
Loading…
Add table
Add a link
Reference in a new issue