From 43c7d7ceb8da17954aedee96bd6fb5444a4a728c Mon Sep 17 00:00:00 2001 From: halcy Date: Tue, 29 Nov 2022 00:50:02 +0200 Subject: Restructure the docs, a lot --- docs/04_auth.rst | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) (limited to 'docs/04_auth.rst') 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 @@ -App registration and user authentication -======================================== +App registration, authentication and preferences +================================================ .. py:module:: mastodon .. py:class: Mastodon @@ -20,12 +20,13 @@ once, and then persist your client id and secret. A convenient method for this is provided by the functions dealing with registering the app, logging in and the Mastodon classes constructor. -To talk to an instance different from the flagship instance, specify -the api_base_url (usually, just the URL of the instance, i.e. -https://mastodon.social/ for the flagship instance). If no protocol -is specified, Mastodon.py defaults to https. - +App registration and information +-------------------------------- .. automethod:: Mastodon.create_app +.. automethod:: Mastodon.app_verify_credentials + +Authentication +-------------- .. automethod:: Mastodon.__init__ .. _log_in(): .. automethod:: Mastodon.log_in @@ -36,3 +37,7 @@ is specified, Mastodon.py defaults to https. .. automethod:: Mastodon.revoke_access_token .. automethod:: Mastodon.create_account .. automethod:: Mastodon.email_resend_confirmation + +User preferences +---------------- +.. automethod:: Mastodon.preferences \ No newline at end of file -- cgit v1.2.3