Added simple quickstart document.

JNRowe · JNRowe · commit 9507cdaf1662 · 2011-04-12T11:19:35.000+01:00
diff --git a/doc/conf.py b/doc/conf.py
@@ -25,7 +25,7 @@
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.ifconfig']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.ifconfig', 'sphinx.ext.intersphinx']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['.templates']
@@ -218,3 +218,5 @@
 
 autoclass_content = "init"
 autodoc_default_flags = ['members', ]
+
+intersphinx_mapping = {'http://docs.python.org/': None}
diff --git a/doc/index.rst b/doc/index.rst
@@ -23,6 +23,7 @@ Contents
    :maxdepth: 2
 
    install
+   quickstart
    api/index
    license
 
@@ -32,4 +33,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-
diff --git a/doc/quickstart.rst b/doc/quickstart.rst
@@ -0,0 +1,34 @@
+Quickstart
+==========
+
+Once ``python-github2`` is installed we can open an interactive Python session,
+and perform some basic tasks to familiarise ourselves with the package.
+
+Create an unauthenticated client object::
+
+    >>> github = Github()
+
+.. note::
+   Creating an unauthenticated client object means we can play with the API
+   without fear of creating or deleting data on our account.
+
+See how many followers the ``python-github2`` project has::
+
+    >>> len(github.repos.watchers("ask/python-github2"))
+    129
+
+Read the description of the ``python-github2`` project::
+
+    >>> repo = github.repos.show("ask/python-github2")
+    >>> repo.description
+
+We can take advantage of Python's :py:func:`dir` to explore the package a
+little more::
+
+    >>> filter(lambda s: not s.startswith("_"), dir(github.users))
+    ['domain', 'follow', 'followers', 'following', 'get_value', 'get_values',
+     'make_request', 'request', 'search', 'search_by_email', 'show',
+     'unfollow']
+
+For more information on specific functionality see the :doc:`api/index`, and the
+copious examples contained within.
