Skip to content

Commit 35bf0c3

Browse files
committed
Adds docs for flask
1 parent 0754420 commit 35bf0c3

File tree

3 files changed

+10
-3
lines changed

3 files changed

+10
-3
lines changed

doc/conf.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -272,4 +272,7 @@ def read(fname):
272272

273273

274274
# Example configuration for intersphinx: refer to the Python standard library.
275-
intersphinx_mapping = {'http://docs.python.org/': None}
275+
intersphinx_mapping = {
276+
'http://docs.python.org/': None,
277+
'http://pythonhosted.org/mwapi/': None,
278+
'http://docs.python-requests.org/en/master/': None}

doc/flask.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
mwoauth.flask
2+
=============
3+
4+
.. automodule:: mwoauth.flask

doc/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
MediaWiki OAuth Library Documentation
77
=====================================
88

9-
``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.
9+
``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.
1010

1111
**Compatible with python 2.7 and 3.x**
1212

@@ -19,6 +19,7 @@ There are two ways to use this library:
1919

2020
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).
2121

22+
There's also a :class:`flask.Blueprint` handler. See :mod:`mwoauth.flask`.
2223

2324
The OAuth Handshaker
2425
====================
@@ -80,4 +81,3 @@ Indices and tables
8081
* :ref:`genindex`
8182
* :ref:`modindex`
8283
* :ref:`search`
83-

0 commit comments

Comments
 (0)