diff --git a/.gitignore b/.gitignore index 87dc283..1d520e8 100644 --- a/.gitignore +++ b/.gitignore @@ -17,6 +17,8 @@ env # PyCharm users, please keep your data locally. .idea/ +docs/_build + .tox nosetests.xml coverage.xml diff --git a/CHANGES.txt b/CHANGES.rst similarity index 100% rename from CHANGES.txt rename to CHANGES.rst diff --git a/docs/providers/github.rst b/docs/providers/github.rst index f836049..7efdba3 100644 --- a/docs/providers/github.rst +++ b/docs/providers/github.rst @@ -7,8 +7,8 @@ It requires a Github Application to have been created to use. Github Links: * `Register a New Github Application - `_ -* `Github OAuth API `_ + `__ +* `Github OAuth API `__ Settings diff --git a/docs/providers/google_hybrid.rst b/docs/providers/google_hybrid.rst index 599c4a6..f3c78b0 100644 --- a/docs/providers/google_hybrid.rst +++ b/docs/providers/google_hybrid.rst @@ -12,11 +12,11 @@ services. Google Developer Links: * `Google Application Management - `_ + `__ * `Google OpenID Documentation - `_ + `__ * `Google OAuth scope parameters - `_ + `__ Settings @@ -45,7 +45,7 @@ POST Parameters The Google provider accepts an oauth_scope argument, which is used in the authenticating request to access additional Google API's. Each API has an authentication scope, defined on the -`Google Auth Scopes `_ +`Google Auth Scopes `__ page. These should be a *space* separated string, for example to request access to Google Contacts: diff --git a/docs/providers/google_oauth2.rst b/docs/providers/google_oauth2.rst index 0c3735c..7139867 100644 --- a/docs/providers/google_oauth2.rst +++ b/docs/providers/google_oauth2.rst @@ -4,9 +4,9 @@ Google OAuth2.0 - :mod:`velruse.providers.google_oauth2` Google Developer Links: * `Google Application Management - `_ + `__ * `Configuring OAuth2.0 in Your Application - `_ + `__ Settings diff --git a/docs/providers/live.rst b/docs/providers/live.rst index 2bff1ed..e30e2a5 100644 --- a/docs/providers/live.rst +++ b/docs/providers/live.rst @@ -15,9 +15,9 @@ The Windows Live Provider supports the Windows Live OAuth 2.0 API. Windows Live Developer Links: -* `Windows Live `_ +* `Windows Live `__ * `Windows Live OAuth 2.0 SDK - `_ + `__ Settings diff --git a/docs/providers/mailru.rst b/docs/providers/mailru.rst index 2d5fa77..1ae5c72 100644 --- a/docs/providers/mailru.rst +++ b/docs/providers/mailru.rst @@ -1,5 +1,5 @@ Mail.ru - :mod:`velruse.providers.mailru` -======================================== +========================================= The Mail.ru provider combines authentication with OAuth 2.0 authorization. It requires either a Mail.ru Site or a Mail.ru Application @@ -9,11 +9,11 @@ to have been created to use. Mail.ru Links (Russian): * `Register a new Mail.ru Site - `_ + `__ * `Register a new Mail.ru Application - `_ -* `Mail.ru OAuth Developer Guide `_ -* `Mail.ru API Guide `_ + `__ +* `Mail.ru OAuth Developer Guide `__ +* `Mail.ru API Guide `__ Settings @@ -25,7 +25,6 @@ Settings Mail.ru Secret Key - POST Parameters --------------- diff --git a/docs/providers/openid.rst b/docs/providers/openid.rst index 9467b80..56a61d0 100644 --- a/docs/providers/openid.rst +++ b/docs/providers/openid.rst @@ -3,17 +3,17 @@ OpenID - :mod:`velruse.providers.openid` The OpenID provider does standard OpenID authentication, using both the `Simple Registration Extension -`_ -and many of the `Attribute Exchange `_ +`__ +and many of the `Attribute Exchange `__ attributes to acquire as much user information to assist in the authentication process as possible. OpenID Developer Links: * `OpenID Authentication 2.0 - `_ + `__ * `Attribute Exchange 1.0 - `_ + `__ Settings @@ -24,7 +24,7 @@ Settings ``store`` An instance of an OpenID store. The default (`None`) is to run in `stateless mode - `_. + `__. It is recommended to use a conforming OpenID store if possible as stateless mode can be more chatty. diff --git a/docs/providers/twitter.rst b/docs/providers/twitter.rst index 6c62635..4684003 100644 --- a/docs/providers/twitter.rst +++ b/docs/providers/twitter.rst @@ -8,8 +8,8 @@ access token. Twitter Developer Links: -* `Register a New Twitter Application `_ -* `Twitter OAuth API `_ +* `Register a New Twitter Application `__ +* `Twitter OAuth API `__ Settings diff --git a/docs/providers/vk.rst b/docs/providers/vk.rst index f862236..e52f49b 100644 --- a/docs/providers/vk.rst +++ b/docs/providers/vk.rst @@ -14,7 +14,7 @@ consumer key and a consumer secret specific to VK. VK Developer Links: * `Developer Page (View apps, create app) - `_ + `__ @@ -28,7 +28,7 @@ Settings ``scope`` Comma-separated list of permissions. The scope is used to request access to VK properties known as - `Application Access Rights `_. + `Application Access Rights `__. It should be either a comma-separated or space-separated list. diff --git a/docs/providers/yahoo.rst b/docs/providers/yahoo.rst index 749cfae..84dbab1 100644 --- a/docs/providers/yahoo.rst +++ b/docs/providers/yahoo.rst @@ -10,9 +10,9 @@ issue. Using the Yahoo OAuth requires registration of a Yahoo application. Yahoo Developer Links: * `Yahoo Developer Projects Page (Create new apps here) - `_ + `__ * `Yahoo OpenID + OAuth Guide - `_ + `__ Settings diff --git a/docs/providers/yandex.rst b/docs/providers/yandex.rst index 08dc611..8765678 100644 --- a/docs/providers/yandex.rst +++ b/docs/providers/yandex.rst @@ -6,15 +6,15 @@ It requires a Yandex Application to have been created to use. Yandex Links (English): -* `Yandex Services OAuth API `_ +* `Yandex Services OAuth API `__ Yandex Links (Russian): * `Register a New Yandex Application - `_ -* `Yandex Services OAuth API `_ -* `Yandex Login + OAuth API `_ + `__ +* `Yandex Services OAuth API `__ +* `Yandex Login + OAuth API `__ Settings