Merge pull request #169 from dasevilla/organize-docs

Organize documentation into directories
oauthlib · May 31, 2013 · 79214fe · 79214fe
2 parents 6bb2200 + fa0dbbb
commit 79214fe
Show file tree

Hide file tree

Showing 23 changed files with 43 additions and 47 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -17,32 +17,17 @@ For news and discussions please check out our `G+ OAuthLib community`_.
 .. toctree::
    :maxdepth: 2
 
+   oauth_1_versus_oauth_2
+   oauth1/oauth1
+   oauth2/oauth2
    contributing
    faq
    feature_matrix
 
-.. toctree::
-   :maxdepth: 2
-
-   oauth_1_versus_oauth_2
-
-.. toctree::
-   :maxdepth: 2
-
-   client
-   server
-
-.. toctree::
-   :maxdepth: 2
-
-   oauth2_overview
-   client2
-   server2
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-
diff --git a/docs/client.rst → docs/oauth1/client.rst b/docs/client.rst → docs/oauth1/client.rst
diff --git a/docs/oauth1/oauth1.rst b/docs/oauth1/oauth1.rst
@@ -0,0 +1,9 @@
+OAuth 1.0
+=========
+
+.. toctree::
+   :maxdepth: 2
+
+   client
+   server
+
diff --git a/docs/server.rst → docs/oauth1/server.rst b/docs/server.rst → docs/oauth1/server.rst
diff --git a/docs/backendapplicationclient.rst → ...uth2/clients/backendapplicationclient.rst b/docs/backendapplicationclient.rst → ...uth2/clients/backendapplicationclient.rst
diff --git a/docs/baseclient.rst → docs/oauth2/clients/baseclient.rst b/docs/baseclient.rst → docs/oauth2/clients/baseclient.rst
diff --git a/docs/client2.rst → docs/oauth2/clients/client.rst b/docs/client2.rst → docs/oauth2/clients/client.rst
diff --git a/docs/legacyapplicationclient.rst → ...auth2/clients/legacyapplicationclient.rst b/docs/legacyapplicationclient.rst → ...auth2/clients/legacyapplicationclient.rst
diff --git a/docs/mobileapplicationclient.rst → ...auth2/clients/mobileapplicationclient.rst b/docs/mobileapplicationclient.rst → ...auth2/clients/mobileapplicationclient.rst
diff --git a/docs/webapplicationclient.rst → docs/oauth2/clients/webapplicationclient.rst b/docs/webapplicationclient.rst → docs/oauth2/clients/webapplicationclient.rst
diff --git a/docs/endpoints.rst → docs/oauth2/endpoints.rst b/docs/endpoints.rst → docs/oauth2/endpoints.rst
@@ -11,9 +11,6 @@ certain users resources to a client, to supply said client with a token
 embodying this authorization and to verify that the token is valid when the
 client attempts to access thee user resources on their behalf.
 
-**Much of the logic presented in code snippets below can be conveniently
-extracted away into a decorator class.** See :doc:`decorators` for examples.
-
 -------------
 Authorization
 -------------

diff --git a/docs/authcode.rst → docs/oauth2/grants/authcode.rst b/docs/authcode.rst → docs/oauth2/grants/authcode.rst
diff --git a/docs/credentials.rst → docs/oauth2/grants/credentials.rst b/docs/credentials.rst → docs/oauth2/grants/credentials.rst
diff --git a/docs/implicit.rst → docs/oauth2/grants/implicit.rst b/docs/implicit.rst → docs/oauth2/grants/implicit.rst
diff --git a/docs/password.rst → docs/oauth2/grants/password.rst b/docs/password.rst → docs/oauth2/grants/password.rst
diff --git a/docs/oauth2/oauth2.rst b/docs/oauth2/oauth2.rst
@@ -0,0 +1,9 @@
+OAuth 2.0
+=========
+
+.. toctree::
+   :maxdepth: 2
+
+   overview
+   clients/client
+   server
diff --git a/docs/oauth2_overview.rst → docs/oauth2/overview.rst b/docs/oauth2_overview.rst → docs/oauth2/overview.rst
@@ -31,10 +31,10 @@ Grant types
 .. toctree::
     :maxdepth: 2
 
-    authcode
-    implicit
-    password
-    credentials
+    grants/authcode
+    grants/implicit
+    grants/password
+    grants/credentials
 
 Grant types are what make OAuth 2 so flexible. The Authorization Code grant is
 very similar to OAuth 1 (with less crypto), the Implicit grant serves less

diff --git a/docs/preconfigured_servers.rst → docs/oauth2/preconfigured_servers.rst b/docs/preconfigured_servers.rst → docs/oauth2/preconfigured_servers.rst
@@ -3,11 +3,7 @@ Preconfigured all-in-one servers
 
 A pre configured server is an all-in-one endpoint serving a specific class of
 application clients. As the individual endpoints, they depend on the use of a
-:doc:`validator`.
-
-Once constructed they can be plugged into any of the available :doc:`decorators`
-or used on their own. For the latter case you might be interested in looking at
-:doc:`endpoints`.
+:doc:`validator`. See also :doc:`endpoints`.
 
 Construction is simple, only import your validator and you are good to go::
 

diff --git a/docs/security.rst → docs/oauth2/security.rst b/docs/security.rst → docs/oauth2/security.rst
diff --git a/docs/server2.rst → docs/oauth2/server.rst b/docs/server2.rst → docs/oauth2/server.rst
diff --git a/docs/tokens.rst → docs/oauth2/tokens.rst b/docs/tokens.rst → docs/oauth2/tokens.rst
diff --git a/docs/validator.rst → docs/oauth2/validator.rst b/docs/validator.rst → docs/oauth2/validator.rst
diff --git a/docs/oauth_1_versus_oauth_2.rst b/docs/oauth_1_versus_oauth_2.rst
@@ -21,51 +21,51 @@ taken to restrict non authenticated clients access to resources appropriately.
   access to your users resources to a malicious third party which has
   stolen tokens (but not authentication secrets) from one of your clients.
 
-    **(Provider)** Offer :doc:`authcode`. Impact can be limited by not
+    **(Provider)** Offer :doc:`oauth2/grants/authcode`. Impact can be limited by not
     providing refresh tokens.
-    Default in :doc:`WebApplicationServer <preconfigured_servers>`.
+    Default in :doc:`WebApplicationServer <oauth2/preconfigured_servers>`.
 
-    **(Client)** Use :doc:`Web Application Client <webapplicationclient>`.
+    **(Client)** Use :doc:`Web Application Client <oauth2/clients/webapplicationclient>`.
 
 * Similar to above, but you are unwilling to risk malicious access based on
   stolen tokens alone.
 
-    **(Provider)** Offer :doc:`OAuth 1 <server>`.
+    **(Provider)** Offer :doc:`OAuth 1 <oauth1/server>`.
 
-    **(Client)** Use :doc:`OAuth 1 Client <client>`.
+    **(Client)** Use :doc:`OAuth 1 Client <oauth1/client>`.
 
 * Your clients reside in user controlled devices with the ability to authorize
   through a web based workflow. This workflow is inherently insecure, restrict
   the privileges associated with tokens accordingly.
 
-    **(Provider)** Offer :doc:`implicit`.
-    Default in :doc:`MobileApplicationServer <preconfigured_servers>`.
+    **(Provider)** Offer :doc:`oauth2/grants/implicit`.
+    Default in :doc:`MobileApplicationServer <oauth2/preconfigured_servers>`.
 
-    **(Client)** Use :doc:`Mobile Application Client <mobileapplicationclient>`.
+    **(Client)** Use :doc:`Mobile Application Client <oauth2/clients/mobileapplicationclient>`.
 
 * Similar to above but without the ability to use web authorization. These
   clients must have a strong trust relationship with the users although
   they offer no additional security.
 
-    **(Provider)** Offer non authenticated :doc:`password`.
-    Default in :doc:`LegacyApplicationServer <preconfigured_servers>`.
+    **(Provider)** Offer non authenticated :doc:`oauth2/grants/password`.
+    Default in :doc:`LegacyApplicationServer <oauth2/preconfigured_servers>`.
 
-    **(Client)** Use :doc:`Legacy Application Client <legacyapplicationclient>`.
+    **(Client)** Use :doc:`Legacy Application Client <oauth2/clients/legacyapplicationclient>`.
 
 * Your clients are transitioning from using usernames/passwords to interact with your
   API to using OAuth tokens but for various reasons don't wish to use the web based
   authorization workflow. The clients reside in secure environments and have a strong
   trust relationship with their users.
 
-    **(Provider)** Offer authenticated :doc:`password`.
-    Default in :doc:`LegacyApplicationServer <preconfigured_servers>`.
+    **(Provider)** Offer authenticated :doc:`oauth2/grants/password`.
+    Default in :doc:`LegacyApplicationServer <oauth2/preconfigured_servers>`.
 
-    **(Client)** Use :doc:`Legacy Application Client <legacyapplicationclient>`.
+    **(Client)** Use :doc:`Legacy Application Client <oauth2/clients/legacyapplicationclient>`.
 
 * You wish to run an internal, highly trusted, job acting on protected
   resources but not interacting with users.
 
-    **(Provider)** Offer :doc:`credentials`.
-    Default in :doc:`BackendApplicationServer <preconfigured_servers>`.
+    **(Provider)** Offer :doc:`oauth2/grants/credentials`.
+    Default in :doc:`BackendApplicationServer <oauth2/preconfigured_servers>`.
 
-    **(Client)** Use :doc:`Backend Application Client <backendapplicationclient>`.
+    **(Client)** Use :doc:`Backend Application Client <oauth2/clients/backendapplicationclient>`.