diff options
author | halcy <halcy@ARARAGI-KUN> | 2022-11-29 00:50:02 +0200 |
---|---|---|
committer | halcy <halcy@ARARAGI-KUN> | 2022-11-29 00:50:02 +0200 |
commit | 43c7d7ceb8da17954aedee96bd6fb5444a4a728c (patch) | |
tree | bb7cdad59a16447841adc15cb047202b47661220 /docs/04_auth.rst | |
parent | bd3db974d771d753e7732fabe6a050b779c466e2 (diff) | |
download | mastodon.py-43c7d7ceb8da17954aedee96bd6fb5444a4a728c.tar.gz |
Restructure the docs, a lot
Diffstat (limited to 'docs/04_auth.rst')
-rw-r--r-- | docs/04_auth.rst | 19 |
1 files changed, 12 insertions, 7 deletions
diff --git a/docs/04_auth.rst b/docs/04_auth.rst index 1a05603..845ffde 100644 --- a/docs/04_auth.rst +++ b/docs/04_auth.rst | |||
@@ -1,5 +1,5 @@ | |||
1 | App registration and user authentication | 1 | App registration, authentication and preferences |
2 | ======================================== | 2 | ================================================ |
3 | .. py:module:: mastodon | 3 | .. py:module:: mastodon |
4 | .. py:class: Mastodon | 4 | .. py:class: Mastodon |
5 | 5 | ||
@@ -20,12 +20,13 @@ once, and then persist your client id and secret. A convenient method | |||
20 | for this is provided by the functions dealing with registering the app, | 20 | for this is provided by the functions dealing with registering the app, |
21 | logging in and the Mastodon classes constructor. | 21 | logging in and the Mastodon classes constructor. |
22 | 22 | ||
23 | To talk to an instance different from the flagship instance, specify | 23 | App registration and information |
24 | the api_base_url (usually, just the URL of the instance, i.e. | 24 | -------------------------------- |
25 | https://mastodon.social/ for the flagship instance). If no protocol | ||
26 | is specified, Mastodon.py defaults to https. | ||
27 | |||
28 | .. automethod:: Mastodon.create_app | 25 | .. automethod:: Mastodon.create_app |
26 | .. automethod:: Mastodon.app_verify_credentials | ||
27 | |||
28 | Authentication | ||
29 | -------------- | ||
29 | .. automethod:: Mastodon.__init__ | 30 | .. automethod:: Mastodon.__init__ |
30 | .. _log_in(): | 31 | .. _log_in(): |
31 | .. automethod:: Mastodon.log_in | 32 | .. automethod:: Mastodon.log_in |
@@ -36,3 +37,7 @@ is specified, Mastodon.py defaults to https. | |||
36 | .. automethod:: Mastodon.revoke_access_token | 37 | .. automethod:: Mastodon.revoke_access_token |
37 | .. automethod:: Mastodon.create_account | 38 | .. automethod:: Mastodon.create_account |
38 | .. automethod:: Mastodon.email_resend_confirmation | 39 | .. automethod:: Mastodon.email_resend_confirmation |
40 | |||
41 | User preferences | ||
42 | ---------------- | ||
43 | .. automethod:: Mastodon.preferences \ No newline at end of file | ||