From dd6184148148e7e1a53449b850bd776fee416e65 Mon Sep 17 00:00:00 2001 From: Mike Helmick Date: Fri, 7 Jun 2013 20:54:52 -0400 Subject: [PATCH] Fork Me badge, more docs [ci skip] --- docs/_static/custom.css | 8 +++++++- docs/_themes/basicstrap/layout.html | 2 ++ docs/api.rst | 8 +++++--- docs/index.rst | 2 +- docs/usage/advanced_usage.rst | 14 ++++++++++++++ docs/usage/starting_out.rst | 8 ++++---- 6 files changed, 33 insertions(+), 9 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index e68036b..b7694cc 100644 --- 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 index b1b344c..88a1f29 100755 --- a/docs/_themes/basicstrap/layout.html +++ b/docs/_themes/basicstrap/layout.html @@ -23,6 +23,8 @@ {%- set titlesuffix = "" %} {%- endif %} +Fork me on GitHub + {%- macro relbar() %}
diff --git a/docs/api.rst b/docs/api.rst index 6e112d1..1ac1b97 100644 --- 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 \ No newline at end of file +.. autoexception:: twython.TwythonError +.. autoexception:: twython.TwythonAuthError +.. autoexception:: twython.TwythonRateLimitError \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 55b7db9..47e28de 100644 --- 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 index 945dc19..a22b5d4 100644 --- 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 `_ + +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! \ No newline at end of file diff --git a/docs/usage/starting_out.rst b/docs/usage/starting_out.rst index 6e2d8be..846874e 100644 --- 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 +^^^^^^^^^^^^^^^^^^^^ ::