adding adapter section to docs

vintasoftware · Feb 26, 2016 · 925ad30 · 925ad30
1 parent 501780e
commit 925ad30
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/docs/source/adapter.rst b/docs/source/adapter.rst
@@ -1,18 +1,23 @@
-==========
+=======
 Adapter
-==========
+=======
+
+**This document is under devolpment, it should show describe all Adapter methods and how to use them**
+
 
 Authentication helpers
----------------------
+----------------------
 
 You can implement the ```refresh_authentication``` and ```is_authentication_expired``` methods in your Tapioca Client to refresh your authentication token every time that it expires.
 ```is_authentication_expired``` receives an error object from the request method (it contains the server response and HTTP Status code). You can use it to decide if a request failed because of the token. This method should return true if the authentication is expired or false otherwise.
 
 If the authentication is expired, ```refresh_authentication``` is called. This method does not receive any parameter.
 
 .. code-block:: python
+
     def is_authentication_expired(self,error)
         ....
+    
     def refresh_authentication(self):
         ...
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -9,6 +9,7 @@ Contents:
 
 	about
 	quickstart
+	adapter
 	serializers
 	exceptions
 	flavours