add module / class stuff

halcy · Nov 27, 2022 · bd3db97 · bd3db97
1 parent 10d48d7
commit bd3db97
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 0 deletions.
diff --git a/docs/01_general.rst b/docs/01_general.rst
@@ -1,5 +1,7 @@
 General information
 ===================
+.. py:module:: mastodon
+.. py:class: Mastodon
 
 Rate limiting
 -------------

diff --git a/docs/02_return_values.rst b/docs/02_return_values.rst
@@ -1,5 +1,7 @@
 Return values
 =============
+.. py:module:: mastodon
+.. py:class: Mastodon
 
 Unless otherwise specified, all data is returned as Python dictionaries, matching
 the JSON format used by the API. Dates returned by the API are in ISO 8601 format

diff --git a/docs/03_errors.rst b/docs/03_errors.rst
@@ -1,5 +1,8 @@
 Error handling
 ==============
+.. py:module:: mastodon
+.. py:class: Mastodon
+
 When Mastodon.py encounters an error, it will raise an exception, generally with
 some text included to tell you what went wrong.
 

diff --git a/docs/04_auth.rst b/docs/04_auth.rst
@@ -1,5 +1,7 @@
 App registration and user authentication
 ========================================
+.. py:module:: mastodon
+.. py:class: Mastodon
 
 Before you can use the Mastodon API, you have to register your
 application (which gets you a client key and client secret)