Refer to package as github2 throughout.

JNRowe · JNRowe · commit 171f71cb5a18 · 2011-04-30T10:11:39.000+01:00
It is apparently quite confusing to read the docs with python-github2/github2
used in various places.
diff --git a/README.rst b/README.rst
@@ -1,5 +1,5 @@
 ================================================================================
-python-github2 - Github API v2 library for Python.
+github2 - Github API v2 library for Python.
 ================================================================================
 
 :Authors:
diff --git a/doc/api/client.rst b/doc/api/client.rst
@@ -1,3 +1,5 @@
+.. module:: github2.client
+
 Creating a client
 =================
 
diff --git a/doc/api/commit.rst b/doc/api/commit.rst
@@ -1,8 +1,8 @@
+.. module:: github2.commits
+
 Commit
 ======
 
-.. py:currentmodule:: github2.commits
-
 .. autoclass:: Commit(type)
 
 .. autoclass:: Commits(type)
diff --git a/doc/api/core.rst b/doc/api/core.rst
@@ -1,11 +1,11 @@
+.. module:: github2.core
+
 Core
 ====
 
-.. py:currentmodule:: github2.core
-
 .. note::
    This module contains functionality that isn't useful to general users
-   of the ``python-github2`` package, but it is documented to aid contributors
+   of the :mod:`github2` package, but it is documented to aid contributors
    to the package.
 
 .. autofunction:: ghdate_to_datetime
diff --git a/doc/api/index.rst b/doc/api/index.rst
@@ -12,7 +12,7 @@ API documentation
    commit
    object
 
-Additionally the following documentation may be useful to ``python-github2``
+Additionally the following documentation may be useful to :mod:`github2`
 contributors:
 
 .. toctree::
diff --git a/doc/api/issues.rst b/doc/api/issues.rst
@@ -1,8 +1,8 @@
+.. module:: github2.issues
+
 Issues
 ======
 
-.. py:currentmodule:: github2.issues
-
 .. autoclass:: Issue(type)
 
 .. autoclass:: Comment(type)
diff --git a/doc/api/repos.rst b/doc/api/repos.rst
@@ -1,8 +1,8 @@
+.. module:: github2.repositories
+
 Repository
 ==========
 
-.. py:currentmodule:: github2.repositories
-
 .. autoclass:: Repository(type)
 
 .. autoclass:: Repositories(type)
diff --git a/doc/api/request.rst b/doc/api/request.rst
@@ -1,11 +1,11 @@
+.. module:: github2.request
+
 Requests
 ========
 
-.. py:currentmodule:: github2.request
-
 .. note::
    This module contains functionality that isn't useful to general users
-   of the ``python-github2`` package, but it is documented to aid contributors
+   of the :mod:`github2` package, but it is documented to aid contributors
    to the package.
 
 .. autodata:: GITHUB_URL
diff --git a/doc/api/users.rst b/doc/api/users.rst
@@ -1,8 +1,8 @@
+.. module:: github2.users
+
 Users
 =====
 
-.. py:currentmodule:: github2.users
-
 .. autoclass:: User(type)
 
 .. autoclass:: Users(type)
diff --git a/doc/bugs.rst b/doc/bugs.rst
@@ -1,7 +1,7 @@
 Reporting bugs
 ==============
 
-If you think you've found a bug, or inconsistency, in ``python-github`` please
+If you think you've found a bug, or inconsistency, in :mod:`github2` please
 `report an issue`_.
 
 .. note::
diff --git a/doc/conf.py b/doc/conf.py
@@ -41,7 +41,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'python-github2'
+project = u'github2'
 copyright = u'2011, Ask Solem'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -170,7 +170,7 @@
 #html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'python-github2doc'
+htmlhelp_basename = 'github2doc'
 
 
 # -- Options for LaTeX output --------------------------------------------------
@@ -184,7 +184,7 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'python-github2.tex', u'python-github2 Documentation',
+  ('index', 'github2.tex', u'github2 Documentation',
    u'Ask Solem', 'manual'),
 ]
 
@@ -217,7 +217,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'python-github2', u'python-github2 Documentation',
+    ('index', 'github2', u'github2 Documentation',
      [u'Ask Solem'], 1)
 ]
 
diff --git a/doc/contributing.rst b/doc/contributing.rst
@@ -1,7 +1,7 @@
 Contributing
 ============
 
-Patches for ``python-github2`` are most welcome!
+Patches for :mod:`github2` are most welcome!
 
 Forks on GitHub_ and patches attached to issues are both great ways to
 contribute.  If you're comfortable with ``git`` using a fork hosted on GitHub is
diff --git a/doc/index.rst b/doc/index.rst
@@ -3,8 +3,11 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-:mod:`python-github2` - Github API v2 library for Python
-========================================================
+.. module:: github2
+   :synopsis: GitHub API v2 library for Python
+
+``github2`` - Github API v2 library for Python
+==============================================
 
 .. pypi-release:: github2
    :prefix: Download
diff --git a/doc/install.rst b/doc/install.rst
@@ -1,7 +1,7 @@
 Installation
 ------------
 
-You can install ``python-github2`` either via the Python Package Index (PyPI) or
+You can install :mod:`github2` either via the Python Package Index (PyPI) or
 from source.
 
 To install using ``pip``::
@@ -19,7 +19,7 @@ following::
     $ python setup.py install --user  # to install for a single user
     # python setup.py install  # to install in Python's site-packages
 
-``python-github2`` depends on :pypi:`httplib2`, an excellent package by Joe
+:mod:`github2` depends on :pypi:`httplib2`, an excellent package by Joe
 Gregorio for handling HTTP sessions.  :pypi:`simplejson` is also required when
-using ``python-github2`` with Python 2.4 or 2.5.  If you install via ``pip`` or
+using :mod:`github2` with Python 2.4 or 2.5.  If you install via ``pip`` or
 ``easy_install`` the dependencies should be installed automatically for you.
diff --git a/doc/quickstart.rst b/doc/quickstart.rst
@@ -1,8 +1,8 @@
 Quickstart
 ==========
 
-Once ``python-github2`` is installed we can open an interactive Python session,
-and perform some basic tasks to familiarise ourselves with the package.
+Once :mod:`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::
 
@@ -12,7 +12,7 @@ Create an unauthenticated client object::
    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::
+See how many followers the :mod:`github2` project has::
 
     >>> len(github.repos.watchers("ask/python-github2"))
     129

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. module:: github2.client`
	`2`	`+`
`1`	`3`	`Creating a client`
`2`	`4`	`=================`
`3`	`5`