Adds docs for flask

mediawiki-utilities · Feb 11, 2017 · 35bf0c3 · 35bf0c3
1 parent 0754420
commit 35bf0c3
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 3 deletions.
diff --git 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
@@ -0,0 +1,4 @@
+mwoauth.flask
+=============
+
+.. automodule:: mwoauth.flask
diff --git 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 <https://www.mediawiki.org/wiki/Extension:OAuth>`_ 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 <https://www.mediawiki.org/wiki/Extension:OAuth>`_ 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`
-