Skip to content

Commit f1a35f0

Browse files
committed
Add autodoc for some additional classes
1 parent f4dd7d3 commit f1a35f0

File tree

4 files changed

+35
-1
lines changed

4 files changed

+35
-1
lines changed

docs/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ Modules
7474
github
7575
issues
7676
models
77+
notifications
7778
orgs
7879
pulls
7980
repos

docs/notifications.rst

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
.. module:: github3
2+
.. module:: github3.notifications
3+
4+
Notifications
5+
=============
6+
7+
This part of the documentation covers the :class:`Thread <Thread>` and
8+
:class:`Subscription <Subscription>` objects.
9+
10+
Notification Objects
11+
--------------------
12+
13+
.. autoclass:: Thread
14+
:inherited-members:
15+
16+
------
17+
18+
.. autoclass:: Subscription
19+
:inherited-members:

docs/repos.rst

+14
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ This part of the documentation covers:
1212
- :class:`Deployment <github3.repos.deployment.Deployment>`
1313
- :class:`DeploymentStatus <github3.repos.deployment.DeploymentStatus>`
1414
- :class:`Hook <github3.repos.hook.Hook>`
15+
- :class:`PagesInfo <github3.repos.pages.PagesInfo>`
16+
- :class:`PagesBuild <github3.repos.pages.PagesBuild>`
1517
- :class:`Release <github3.repos.release.Release>`
1618
- :class:`RepoTag <github3.repos.tag.RepoTag>`
1719
- :class:`RepoComment <github3.repos.comment.RepoComment>`
@@ -87,6 +89,18 @@ Repository Objects
8789

8890
---------
8991

92+
.. module:: github3.repos.pages
93+
94+
.. autoclass:: PagesInfo
95+
:members:
96+
97+
---------
98+
99+
.. autoclass:: PagesBuild
100+
:members:
101+
102+
---------
103+
90104
.. module:: github3.repos.tag
91105

92106
.. autoclass:: RepoTag

github3/notifications.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ class Subscription(GitHubCore):
108108
repository subscription information.
109109
110110
See also:
111-
developer.github.com/v3/activity/notifications/#get-a-thread-subscription
111+
http://developer.github.com/v3/activity/notifications/#get-a-thread-subscription
112112
"""
113113
def __init__(self, sub, session=None):
114114
super(Subscription, self).__init__(sub, session)

0 commit comments

Comments
 (0)