Skip to content

Commit

Permalink
Doc update. Might be breaking.
Browse files Browse the repository at this point in the history
  • Loading branch information
halcy committed Nov 24, 2016
1 parent 924baa0 commit 27c343a
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 12 deletions.
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import os
import sys
sys.path.insert(0, os.path.abspath('../'))
autodoc_member_order = 'by_source'
#print(sys.path)

# Add any Sphinx extension module names here, as strings. They can be
Expand Down
33 changes: 21 additions & 12 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -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.
.. py:currentmodule:: mastodon
.. py:class:: Mastodon
Welcome to Mastodon.py's documentation!
=======================================
Mastodon.py
===========

Contents:
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
-----------------

.. toctree::
:maxdepth: 2

.. py:currentmodule:: mastodon
.. autoclass:: Mastodon
:members:

0 comments on commit 27c343a

Please sign in to comment.