Fork Me badge, more docs

michaelhelmick · michaelhelmick · commit dd6184148148 · 2013-06-07T20:54:52.000-04:00
[ci skip]
diff --git a/docs/_static/custom.css b/docs/_static/custom.css
@@ -2,6 +2,12 @@
     margin-bottom: 30px !important;
 }
 
-div.tip {
+.tip {
     color: #3a87ad; /* Basicstrap CSS was messed up so override it */
 }
+
+@media (min-width: 1200px) {
+    .collapse .pull-right{
+        margin-right: 115px !important;
+    }
+}
diff --git a/docs/_themes/basicstrap/layout.html b/docs/_themes/basicstrap/layout.html
@@ -23,6 +23,8 @@
 {%- set titlesuffix = "" %}
 {%- endif %}
 
+<a href="https://github.com/ryanmcgrath/twython" class="visible-desktop hidden-tablet"><img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a>
+
 {%- macro relbar() %}
 <div class="related navbar {% if (theme_relbar_inverse|tobool) %}navbar-inverse{% endif %}">
   <div class="navbar-inner">
diff --git a/docs/api.rst b/docs/api.rst
@@ -21,6 +21,8 @@ Core Interface
 
 .. _streaming_interface:
 
+.. module:: twython.streaming
+
 Streaming Interface
 -------------------
 
@@ -40,6 +42,6 @@ Streaming Types
 Exceptions
 ----------
 
-.. autoexception:: TwythonError
-.. autoexception:: TwythonAuthError
-.. autoexception:: TwythonRateLimitError
+.. autoexception:: twython.TwythonError
+.. autoexception:: twython.TwythonAuthError
+.. autoexception:: twython.TwythonRateLimitError
diff --git a/docs/index.rst b/docs/index.rst
@@ -30,7 +30,7 @@ Usage
 -----
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 4
 
    usage/install
    usage/starting_out
diff --git a/docs/usage/advanced_usage.rst b/docs/usage/advanced_usage.rst
@@ -27,4 +27,18 @@ Documentation: https://dev.twitter.com/docs/api/1.1/get/account/verify_credentia
     photo = open('/path/to/file/image.jpg', 'rb')
     twitter.update_status_with_media(status='Checkout this cool image!', media=photo)
 
+Search Generator
+----------------
+
+So, if you're pretty into Python, you probably know about `generators <http://docs.python.org/2/tutorial/classes.html#generators>`_
+
+That being said, Twython offers a generator for search results and can be accessed by using the following code:
+
+::
+
+    search = twitter.search_gen('python')
+    for result in search:
+        print result
+
+
 So now you can authenticate, update your status (with or without an image), search Twitter, and a few other things! Good luck!
diff --git a/docs/usage/starting_out.rst b/docs/usage/starting_out.rst
@@ -94,8 +94,8 @@ First, you'll want to import Twython::
 
     from twython import Twython
 
-Don't have an OAuth 2 `access_token`?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Obtain an OAuth 2 Access Token
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 ::
 
@@ -107,8 +107,8 @@ Don't have an OAuth 2 `access_token`?
 
     # Save ACCESS_TOKEN in a database or something for later use!
 
-Already have one?
-^^^^^^^^^^^^^^^^^
+Use the Access Token
+^^^^^^^^^^^^^^^^^^^^
 
 ::
 

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,12 @@`
`2`	`2`	`margin-bottom: 30px !important;`
`3`	`3`	`}`
`4`	`4`
`5`		`-div.tip {`
	`5`	`+.tip {`
`6`	`6`	`color: #3a87ad; /* Basicstrap CSS was messed up so override it */`
`7`	`7`	`}`
	`8`	`+`
	`9`	`+@media (min-width: 1200px) {`
	`10`	`+ .collapse .pull-right{`
	`11`	`+ margin-right: 115px !important;`
	`12`	`+ }`
	`13`	`+}`