Doc update. Might be breaking.
This commit is contained in:
pare
924baa064d
commit
27c343a5b1
S'han modificat 2 arxius amb 25 adicions i 15 eliminacions
|
@ -29,6 +29,7 @@
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
sys.path.insert(0, os.path.abspath('../'))
|
sys.path.insert(0, os.path.abspath('../'))
|
||||||
|
autodoc_member_order = 'by_source'
|
||||||
#print(sys.path)
|
#print(sys.path)
|
||||||
|
|
||||||
# Add any Sphinx extension module names here, as strings. They can be
|
# Add any Sphinx extension module names here, as strings. They can be
|
||||||
|
|
|
@ -1,16 +1,25 @@
|
||||||
.. Mastodon.py documentation master file, created by
|
|
||||||
sphinx-quickstart on Thu Nov 24 01:25:38 2016.
|
|
||||||
You can adapt this file completely to your liking, but it should at least
|
|
||||||
contain the root `toctree` directive.
|
|
||||||
|
|
||||||
Welcome to Mastodon.py's documentation!
|
|
||||||
=======================================
|
|
||||||
|
|
||||||
Contents:
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
.. py:currentmodule:: mastodon
|
.. py:currentmodule:: mastodon
|
||||||
.. autoclass:: Mastodon
|
.. py:class:: Mastodon
|
||||||
:members:
|
|
||||||
|
Mastodon.py
|
||||||
|
===========
|
||||||
|
|
||||||
|
App creation and auth
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
Before you can use the mastodon API, you have to register your application (which gets you a client key and client secret)
|
||||||
|
and then log in (which gets you an access token). These functions allow you to do those things.
|
||||||
|
For convenience, once you have a client id, secret and access token, you can simply pass them to the constructor of the class, too!
|
||||||
|
|
||||||
|
Note that while it is perfectly reasonable to log back in whenever your app starts, registering a new application on every
|
||||||
|
startup is not, so don't do that - instead, register an application once, and then persist your client id and secret. Convenience
|
||||||
|
methods for this are provided.
|
||||||
|
|
||||||
|
.. autofunction:: create_app
|
||||||
|
.. automethod:: __init__
|
||||||
|
.. automethod:: log_in
|
||||||
|
|
||||||
|
Reading timelines
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Referencia en una nova incidència