From 35bf0c307ca23da2a77582a50d5fc9d6031e7d2d Mon Sep 17 00:00:00 2001 From: halfak Date: Sat, 11 Feb 2017 16:11:43 -0600 Subject: [PATCH] Adds docs for flask --- doc/conf.py | 5 ++++- doc/flask.rst | 4 ++++ doc/index.rst | 4 ++-- 3 files changed, 10 insertions(+), 3 deletions(-) create mode 100644 doc/flask.rst diff --git a/doc/conf.py b/doc/conf.py index 9fb4e3f..137ada5 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -272,4 +272,7 @@ def read(fname): # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'http://docs.python.org/': None} +intersphinx_mapping = { + 'http://docs.python.org/': None, + 'http://pythonhosted.org/mwapi/': None, + 'http://docs.python-requests.org/en/master/': None} diff --git a/doc/flask.rst b/doc/flask.rst new file mode 100644 index 0000000..81c93a9 --- /dev/null +++ b/doc/flask.rst @@ -0,0 +1,4 @@ +mwoauth.flask +============= + +.. automodule:: mwoauth.flask diff --git a/doc/index.rst b/doc/index.rst index c1d9403..7dd528f 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -6,7 +6,7 @@ MediaWiki OAuth Library Documentation ===================================== -``mwoauth`` is an open licensed (MIT) library designed to provide a simple means to performing an OAuth handshake with a MediaWiki installation with the `OAuth Extension `_ installed. +``mwoauth`` is an open licensed (MIT) library designed to provide a simple means to performing an OAuth handshake with a MediaWiki installation with the `OAuth Extension `_ installed. **Compatible with python 2.7 and 3.x** @@ -19,6 +19,7 @@ There are two ways to use this library: Both of strategies make use of the same set of tokens (:class:`~mwoauth.ConsumerToken`, :class:`~mwoauth.RequestToken` and :class:`~mwoauth.AccessToken`) and are totally inter-operable (if you like to mixing things up). +There's also a :class:`flask.Blueprint` handler. See :mod:`mwoauth.flask`. The OAuth Handshaker ==================== @@ -80,4 +81,3 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :ref:`search` -