diff options
| author | halcy <halcy@ARARAGI-KUN> | 2022-11-28 01:45:00 +0200 |
|---|---|---|
| committer | halcy <halcy@ARARAGI-KUN> | 2022-11-28 01:45:00 +0200 |
| commit | bd3db974d771d753e7732fabe6a050b779c466e2 (patch) | |
| tree | a930b779e62b731ec041cab02a484cbdf9ce3099 /docs | |
| parent | 10d48d702d71add36d44e3db54bd7b38766bad15 (diff) | |
| download | mastodon.py-bd3db974d771d753e7732fabe6a050b779c466e2.tar.gz | |
add module / class stuff
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/01_general.rst | 2 | ||||
| -rw-r--r-- | docs/02_return_values.rst | 2 | ||||
| -rw-r--r-- | docs/03_errors.rst | 3 | ||||
| -rw-r--r-- | docs/04_auth.rst | 2 |
4 files changed, 9 insertions, 0 deletions
diff --git a/docs/01_general.rst b/docs/01_general.rst index f16dfb6..e0c3719 100644 --- a/docs/01_general.rst +++ b/docs/01_general.rst | |||
| @@ -1,5 +1,7 @@ | |||
| 1 | General information | 1 | General information |
| 2 | =================== | 2 | =================== |
| 3 | .. py:module:: mastodon | ||
| 4 | .. py:class: Mastodon | ||
| 3 | 5 | ||
| 4 | Rate limiting | 6 | Rate limiting |
| 5 | ------------- | 7 | ------------- |
diff --git a/docs/02_return_values.rst b/docs/02_return_values.rst index 52947e9..9cc1e77 100644 --- a/docs/02_return_values.rst +++ b/docs/02_return_values.rst | |||
| @@ -1,5 +1,7 @@ | |||
| 1 | Return values | 1 | Return values |
| 2 | ============= | 2 | ============= |
| 3 | .. py:module:: mastodon | ||
| 4 | .. py:class: Mastodon | ||
| 3 | 5 | ||
| 4 | Unless otherwise specified, all data is returned as Python dictionaries, matching | 6 | Unless otherwise specified, all data is returned as Python dictionaries, matching |
| 5 | the JSON format used by the API. Dates returned by the API are in ISO 8601 format | 7 | 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 index fce7af7..c129783 100644 --- a/docs/03_errors.rst +++ b/docs/03_errors.rst | |||
| @@ -1,5 +1,8 @@ | |||
| 1 | Error handling | 1 | Error handling |
| 2 | ============== | 2 | ============== |
| 3 | .. py:module:: mastodon | ||
| 4 | .. py:class: Mastodon | ||
| 5 | |||
| 3 | When Mastodon.py encounters an error, it will raise an exception, generally with | 6 | When Mastodon.py encounters an error, it will raise an exception, generally with |
| 4 | some text included to tell you what went wrong. | 7 | some text included to tell you what went wrong. |
| 5 | 8 | ||
diff --git a/docs/04_auth.rst b/docs/04_auth.rst index 454d6a2..1a05603 100644 --- a/docs/04_auth.rst +++ b/docs/04_auth.rst | |||
| @@ -1,5 +1,7 @@ | |||
| 1 | App registration and user authentication | 1 | App registration and user authentication |
| 2 | ======================================== | 2 | ======================================== |
| 3 | .. py:module:: mastodon | ||
| 4 | .. py:class: Mastodon | ||
| 3 | 5 | ||
| 4 | Before you can use the Mastodon API, you have to register your | 6 | Before you can use the Mastodon API, you have to register your |
| 5 | application (which gets you a client key and client secret) | 7 | application (which gets you a client key and client secret) |