Document models

tweepy · Apr 13, 2021 · 0724060 · 0724060
1 parent f5beb23
commit 0724060
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -18,6 +18,7 @@ Contents:
    cursor_tutorial.rst
    api.rst
    client.rst
+   models.rst
    stream.rst
    exceptions.rst
    extended_tweets.rst

diff --git a/docs/models.rst b/docs/models.rst
@@ -0,0 +1,34 @@
+.. _models_reference:
+
+.. currentmodule:: tweepy
+
+****************
+Models Reference
+****************
+
+API v2
+======
+
+.. class:: Media
+
+   :reference: https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/media
+
+.. class:: Place
+
+   :reference: https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/place
+
+.. class:: Poll
+
+   :reference: https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/poll
+
+.. class:: ReferencedTweet
+
+   :reference: https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/tweet
+
+.. class:: Tweet
+
+   :reference: https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/tweet
+
+.. class:: User
+
+   :reference: https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/user