Merge pull request sigmavirus24#236 from bgilbert/doc-xrefs

sigmavirus24 · sigmavirus24 · commit d5999ffc042b · 2014-05-04T13:34:15.000-05:00
Fix up documentation cross references
diff --git a/docs/gists.rst b/docs/gists.rst
@@ -17,20 +17,28 @@ classes should never be instantiated by the user (developer) directly.
 Gist Objects
 ------------
 
+.. module:: github3.gists.gist
+
 .. autoclass:: github3.gists.gist.Gist
     :inherited-members:
 
 ------
 
+.. module:: github3.gists.comment
+
 .. autoclass:: github3.gists.comment.GistComment
     :inherited-members:
 
 ------
 
+.. module:: github3.gists.file
+
 .. autoclass:: github3.gists.file.GistFile
     :inherited-members:
 
 ------
 
+.. module:: github3.gists.history
+
 .. autoclass:: github3.gists.history.GistHistory
     :inherited-members:
diff --git a/docs/index.rst b/docs/index.rst
@@ -74,6 +74,7 @@ Modules
     github
     issues
     models
+    notifications
     orgs
     pulls
     repos
diff --git a/docs/issues.rst b/docs/issues.rst
@@ -14,25 +14,35 @@ This part of the documentation covers the module which handles :class:`Issue
 Issue Objects
 -------------
 
+.. module:: github3.issues.issue
+
 .. autoclass:: github3.issues.issue.Issue
     :inherited-members:
 
 ------
 
+.. module:: github3.issues.comment
+
 .. autoclass:: github3.issues.comment.IssueComment
     :inherited-members:
 
 ------
 
+.. module:: github3.issues.event
+
 .. autoclass:: github3.issues.event.IssueEvent
     :inherited-members:
 
 ------
 
+.. module:: github3.issues.milestone
+
 .. autoclass:: github3.issues.milestone.Milestone
     :inherited-members:
 
 ------
 
+.. module:: github3.issues.label
+
 .. autoclass:: github3.issues.label.Label
     :inherited-members:
diff --git a/docs/notifications.rst b/docs/notifications.rst
@@ -0,0 +1,19 @@
+.. module:: github3
+.. module:: github3.notifications
+
+Notifications
+=============
+
+This part of the documentation covers the :class:`Thread <Thread>` and
+:class:`Subscription <Subscription>` objects.
+
+Notification Objects
+--------------------
+
+.. autoclass:: Thread
+    :inherited-members:
+
+------
+
+.. autoclass:: Subscription
+    :inherited-members:
diff --git a/docs/repos.rst b/docs/repos.rst
@@ -12,6 +12,8 @@ This part of the documentation covers:
 - :class:`Deployment <github3.repos.deployment.Deployment>`
 - :class:`DeploymentStatus <github3.repos.deployment.DeploymentStatus>`
 - :class:`Hook <github3.repos.hook.Hook>`
+- :class:`PagesInfo <github3.repos.pages.PagesInfo>`
+- :class:`PagesBuild <github3.repos.pages.PagesBuild>`
 - :class:`Release <github3.repos.release.Release>`
 - :class:`RepoTag <github3.repos.tag.RepoTag>`
 - :class:`RepoComment <github3.repos.comment.RepoComment>`
@@ -35,21 +37,29 @@ sections of the GitHub documentation.
 Repository Objects
 ------------------
 
+.. module:: github3.repos.repo
+
 .. autoclass:: github3.repos.repo.Repository
     :inherited-members:
 
 ---------
 
+.. module:: github3.repos.branch
+
 .. autoclass:: github3.repos.branch.Branch
     :members:
 
 ---------
 
+.. module:: github3.repos.contents
+
 .. autoclass:: github3.repos.contents.Contents
     :members:
 
 ---------
 
+.. module:: github3.repos.deployment
+
 .. autoclass:: github3.repos.deployment.Deployment
     :members:
 
@@ -60,6 +70,8 @@ Repository Objects
 
 ---------
 
+.. module:: github3.repos.release
+
 .. autoclass:: github3.repos.release.Release
     :members:
 
@@ -70,16 +82,34 @@ Repository Objects
 
 ---------
 
+.. module:: github3.repos.hook
+
 .. autoclass:: github3.repos.hook.Hook
     :members:
 
 ---------
 
+.. module:: github3.repos.pages
+
+.. autoclass:: github3.repos.pages.PagesInfo
+    :members:
+
+---------
+
+.. autoclass:: github3.repos.pages.PagesBuild
+    :members:
+
+---------
+
+.. module:: github3.repos.tag
+
 .. autoclass:: github3.repos.tag.RepoTag
     :members:
 
 ---------
 
+.. module:: github3.repos.comment
+
 More information about this class can be found in the official documentation
 about `comments <http://developer.github.com/v3/repos/comments/>`_.
 
@@ -88,20 +118,28 @@ about `comments <http://developer.github.com/v3/repos/comments/>`_.
 
 ---------
 
+.. module:: github3.repos.commit
+
 .. autoclass:: github3.repos.commit.RepoCommit
     :members:
 
 ---------
 
+.. module:: github3.repos.comparison
+
 .. autoclass:: github3.repos.comparison.Comparison
     :members:
 
 ---------
 
+.. module:: github3.repos.status
+
 .. autoclass:: github3.repos.status.Status
     :members:
 
 ---------
 
+.. module:: github3.repos.stats
+
 .. autoclass:: github3.repos.stats.ContributorStats
     :members:
diff --git a/github3/gists/gist.py b/github3/gists/gist.py
@@ -83,7 +83,8 @@ def __init__(self, data, session=None):
         #: Number of files in this gist.
         self.files = len(self._files)
 
-        #: History of this gist, list of :class:`GistHistory <GistHistory>`
+        #: History of this gist, list of
+        #: :class:`GistHistory <github3.gists.history.GistHistory>`
         self.history = [GistHistory(h, self) for h in data.get('history', [])]
 
         ## New urls
diff --git a/github3/issues/issue.py b/github3/issues/issue.py
@@ -62,12 +62,14 @@ def __init__(self, issue, session=None):
         self.html_url = issue.get('html_url')
         #: Unique ID for the issue.
         self.id = issue.get('id')
-        #: Returns the list of :class:`Label <Label>`\ s on this issue.
+        #: Returns the list of :class:`Label <github3.issues.label.Label>`\ s
+        #: on this issue.
         self.labels = [Label(l, self._session) for l in issue.get('labels')]
         labels_url = issue.get('labels_url')
         #: Labels URL Template. Expand with ``name``
         self.labels_urlt = URITemplate(labels_url) if labels_url else None
-        #: :class:`Milestone <Milestone>` this issue was assigned to.
+        #: :class:`Milestone <github3.issues.milestone.Milestone>` this
+        #: issue was assigned to.
         self.milestone = None
         if issue.get('milestone'):
             self.milestone = Milestone(issue.get('milestone'), self._session)
@@ -145,7 +147,7 @@ def comment(self, id_num):
         sigmavirus24/Todo.txt-python, the first comment's id is 4150787.
 
         :param int id_num: (required), comment id, see example above
-        :returns: :class:`IssueComment <IssueComment>`
+        :returns: :class:`IssueComment <github3.issues.comment.IssueComment>`
         """
         json = None
         if int(id_num) > 0:  # Might as well check that it's positive
@@ -160,7 +162,7 @@ def create_comment(self, body):
         """Create a comment on this issue.
 
         :param str body: (required), comment body
-        :returns: :class:`IssueComment <IssueComment>`
+        :returns: :class:`IssueComment <github3.issues.comment.IssueComment>`
         """
         json = None
         if body:
@@ -213,7 +215,8 @@ def iter_comments(self, number=-1):
         """Iterate over the comments on this issue.
 
         :param int number: (optional), number of comments to iterate over
-        :returns: iterator of :class:`IssueComment <IssueComment>`
+        :returns: iterator of
+            :class:`IssueComment <github3.issues.comment.IssueComment>`\ s
         """
         url = self._build_url('comments', base_url=self._api)
         return self._iter(int(number), url, IssueComment)
@@ -223,7 +226,8 @@ def iter_events(self, number=-1):
 
         :param int number: (optional), number of events to return. Default: -1
             returns all events available.
-        :returns: generator of :class:`IssueEvent <IssueEvent>`\ s
+        :returns: generator of
+            :class:`IssueEvent <github3.issues.event.IssueEvent>`\ s
         """
         url = self._build_url('events', base_url=self._api)
         return self._iter(int(number), url, IssueEvent)
@@ -235,6 +239,7 @@ def iter_labels(self, number=-1, etag=None):
             returns all labels applied to this issue.
         :param str etag: (optional), ETag from a previous request to the same
             endpoint
+        :returns: generator of :class:`Label <github3.issues.label.Label>`\ s
         """
         url = self._build_url('labels', base_url=self._api)
         return self._iter(int(number), url, Label, etag=etag)
diff --git a/github3/issues/milestone.py b/github3/issues/milestone.py
@@ -68,7 +68,7 @@ def iter_labels(self, number=-1, etag=None):
         :param int number: (optional), number of labels to return. Default: -1
             returns all available labels.
         :param str etag: (optional), ETag header from a previous response
-        :returns: generator of :class:`Label <Label>`\ s
+        :returns: generator of :class:`Label <github3.issues.label.Label>`\ s
         """
         url = self._build_url('labels', base_url=self._api)
         return self._iter(int(number), url, Label, etag=etag)
diff --git a/github3/notifications.py b/github3/notifications.py
@@ -86,7 +86,7 @@ def set_subscription(self, subscribed, ignored):
             be received from this thread.
         :param bool ignored: (required), determines if notifications should be
             ignored from this thread.
-        :returns: :class;`Subscription <Subscription>`
+        :returns: :class:`Subscription <Subscription>`
         """
         url = self._build_url('subscription', base_url=self._api)
         sub = {'subscribed': subscribed, 'ignored': ignored}
@@ -108,7 +108,7 @@ class Subscription(GitHubCore):
     repository subscription information.
 
     See also:
-    developer.github.com/v3/activity/notifications/#get-a-thread-subscription
+    http://developer.github.com/v3/activity/notifications/#get-a-thread-subscription
     """
     def __init__(self, sub, session=None):
         super(Subscription, self).__init__(sub, session)
diff --git a/github3/repos/branch.py b/github3/repos/branch.py
@@ -14,8 +14,8 @@ def __init__(self, branch, session=None):
         super(Branch, self).__init__(branch, session)
         #: Name of the branch.
         self.name = branch.get('name')
-        #: Returns the branch's :class:`RepoCommit <RepoCommit>` or
-        #: ``None``.
+        #: Returns the branch's
+        #: :class:`RepoCommit <github3.repos.commit.RepoCommit>` or ``None``.
         self.commit = branch.get('commit')
         if self.commit:
             self.commit = RepoCommit(self.commit, self._session)
diff --git a/github3/repos/comparison.py b/github3/repos/comparison.py
@@ -42,8 +42,8 @@ def __init__(self, compare):
         self.diff_url = compare.get('diff_url')
         #: Patch URL at GitHub for the comparison.
         self.patch_url = compare.get('patch_url')
-        #: :class:`RepoCommit <RepoCommit>` object representing the base of
-        #: comparison.
+        #: :class:`RepoCommit <github3.repos.commit.RepoCommit>` object
+        #: representing the base of comparison.
         self.base_commit = RepoCommit(compare.get('base_commit'), None)
         #: Behind or ahead.
         self.status = compare.get('status')
@@ -53,7 +53,8 @@ def __init__(self, compare):
         self.behind_by = compare.get('behind_by')
         #: Number of commits difference in the comparison.
         self.total_commits = compare.get('total_commits')
-        #: List of :class:`RepoCommit <RepoCommit>` objects.
+        #: List of :class:`RepoCommit <github3.repos.commit.RepoCommit>`
+        #: objects.
         self.commits = [RepoCommit(com) for com in compare.get('commits')]
         #: List of dicts describing the files modified.
         self.files = compare.get('files', [])
diff --git a/github3/repos/release.py b/github3/repos/release.py
@@ -38,7 +38,7 @@ def __init__(self, release, session=None):
         self.id = release.get('id')
         #: Name given to the release
         self.name = release.get('name')
-        #; Boolean whether release is a prelease
+        #; Boolean whether release is a prerelease
         self.prerelease = release.get('prerelease')
         #: Date the release was published
         self.published_at = self._strptime(release.get('published_at'))
diff --git a/github3/repos/repo.py b/github3/repos/repo.py

-Original file line number
+Diff line change
     github
     issues
     models
 +    notifications
     orgs
     pulls
     repos