cleanup some of the docs building

Preston-Landers · Jun 27, 2013 · d7997f0 · d7997f0
1 parent 992547d
commit d7997f0
Show file tree

Hide file tree

Showing 12 changed files with 32 additions and 31 deletions.
diff --git 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 → CHANGES.rst b/CHANGES.txt → CHANGES.rst
diff --git 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
-  <https://github.com/settings/applications/new>`_
-* `Github OAuth API <http://developer.github.com/v3/oauth/>`_
+  <https://github.com/settings/applications/new>`__
+* `Github OAuth API <http://developer.github.com/v3/oauth/>`__
 
 
 Settings

diff --git a/docs/providers/google_hybrid.rst b/docs/providers/google_hybrid.rst
@@ -12,11 +12,11 @@ services.
 Google Developer Links:
 
 * `Google Application Management
-  <https://www.google.com/accounts/ManageDomains>`_
+  <https://www.google.com/accounts/ManageDomains>`__
 * `Google OpenID Documentation
-  <http://code.google.com/apis/accounts/docs/OpenID.html>`_
+  <http://code.google.com/apis/accounts/docs/OpenID.html>`__
 * `Google OAuth scope parameters
-  <http://code.google.com/apis/gdata/faq.html#AuthScopes>`_
+  <http://code.google.com/apis/gdata/faq.html#AuthScopes>`__
 
 
 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 <http://code.google.com/apis/gdata/faq.html#AuthScopes>`_
+`Google Auth Scopes <http://code.google.com/apis/gdata/faq.html#AuthScopes>`__
 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
@@ -4,9 +4,9 @@ Google OAuth2.0 - :mod:`velruse.providers.google_oauth2`
 Google Developer Links:
 
 * `Google Application Management
-  <https://www.google.com/accounts/ManageDomains>`_
+  <https://www.google.com/accounts/ManageDomains>`__
 * `Configuring OAuth2.0 in Your Application
-  <https://developers.google.com/accounts/docs/OAuth2>`_
+  <https://developers.google.com/accounts/docs/OAuth2>`__
 
 
 Settings

diff --git 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 <http://msdn.microsoft.com/en-us/windowslive/default.aspx>`_
+* `Windows Live <http://msdn.microsoft.com/en-us/windowslive/default.aspx>`__
 * `Windows Live OAuth 2.0 SDK
-  <http://msdn.microsoft.com/en-us/library/hh243647.aspx>`_
+  <http://msdn.microsoft.com/en-us/library/hh243647.aspx>`__
 
 
 Settings

diff --git 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
-  <http://api.mail.ru/sites/my/add>`_
+  <http://api.mail.ru/sites/my/add>`__
 * `Register a new Mail.ru Application
-  <http://api.mail.ru/apps/my/add/>`_
-* `Mail.ru OAuth Developer Guide <http://api.mail.ru/docs/guides/oauth/>`_
-* `Mail.ru API Guide <http://api.mail.ru/docs/>`_
+  <http://api.mail.ru/apps/my/add/>`__
+* `Mail.ru OAuth Developer Guide <http://api.mail.ru/docs/guides/oauth/>`__
+* `Mail.ru API Guide <http://api.mail.ru/docs/>`__
 
 
 Settings
@@ -25,7 +25,6 @@ Settings
     Mail.ru Secret Key
 
 
-
 POST Parameters
 ---------------
 

diff --git 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
-<http://openid.net/specs/openid-simple-registration-extension-1_0.html>`_
-and many of the `Attribute Exchange <http://www.axschema.org/types/>`_
+<http://openid.net/specs/openid-simple-registration-extension-1_0.html>`__
+and many of the `Attribute Exchange <http://www.axschema.org/types/>`__
 attributes to acquire as much user information to assist in the
 authentication process as possible.
 
 OpenID Developer Links:
 
 * `OpenID Authentication 2.0
-  <http://openid.net/specs/openid-authentication-2_0.html>`_
+  <http://openid.net/specs/openid-authentication-2_0.html>`__
 * `Attribute Exchange 1.0
-  <http://openid.net/specs/openid-attribute-exchange-1_0.html>`_
+  <http://openid.net/specs/openid-attribute-exchange-1_0.html>`__
 
 
 Settings
@@ -24,7 +24,7 @@ Settings
 ``store``
     An instance of an OpenID store. The default (`None`) is to run in
     `stateless mode
-    <http://openid.net/specs/openid-authentication-2_0.html#check_auth>`_.
+    <http://openid.net/specs/openid-authentication-2_0.html#check_auth>`__.
     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
@@ -8,8 +8,8 @@ access token.
 
 Twitter Developer Links:
 
-* `Register a New Twitter Application <http://dev.twitter.com/apps/new>`_
-* `Twitter OAuth API <http://dev.twitter.com/doc>`_
+* `Register a New Twitter Application <http://dev.twitter.com/apps/new>`__
+* `Twitter OAuth API <http://dev.twitter.com/doc>`__
 
 
 Settings

diff --git 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)
-  <http://vk.com/developers.php>`_
+  <http://vk.com/developers.php>`__
 
 
 
@@ -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 <http://vk.com/developers.php?oid=-17680044&p=Application_Access_Rights>`_.
+    `Application Access Rights <http://vk.com/developers.php?oid=-17680044&p=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
@@ -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)
-  <https://developer.apps.yahoo.com/projects>`_
+  <https://developer.apps.yahoo.com/projects>`__
 * `Yahoo OpenID + OAuth Guide
-  <http://developer.yahoo.com/oauth/guide/openid-oauth-guide.html>`_
+  <http://developer.yahoo.com/oauth/guide/openid-oauth-guide.html>`__
 
 
 Settings

diff --git 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 <http://api.yandex.com/oauth/doc/dg/concepts/authorization-scheme.xml>`_
+* `Yandex Services OAuth API <http://api.yandex.com/oauth/doc/dg/concepts/authorization-scheme.xml>`__
 
 
 Yandex Links (Russian):
 
 * `Register a New Yandex Application
-  <https://oauth.yandex.ru/client/new>`_
-* `Yandex Services OAuth API <http://api.yandex.ru/oauth/doc/dg/concepts/authorization-scheme.xml>`_
-* `Yandex Login + OAuth API <http://api.yandex.ru/login/doc/dg/concepts/about.xml>`_
+  <https://oauth.yandex.ru/client/new>`__
+* `Yandex Services OAuth API <http://api.yandex.ru/oauth/doc/dg/concepts/authorization-scheme.xml>`__
+* `Yandex Login + OAuth API <http://api.yandex.ru/login/doc/dg/concepts/about.xml>`__
 
 
 Settings