10000 continuing work towards 1-to-1 documentation · zzKuRtzz/github3.py@06cbd2d · GitHub
[go: up one dir, main page]
Skip to content

Commit 06cbd2d

Browse files
esacteksabesacteksab
committed
continuing work towards 1-to-1 documentation
1 parent ff3b187 commit 06cbd2d

40 files changed

+1033
-27
lines changed

‎docs/gh/activity.rst

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,13 @@ Activity
33

44
`http://developer.github.com/v3/activity/ <http://developer.github.com/v3/activity/>`_
55

6-
Notifications
7-
~~~~~~~~~~~~~
6+
.. toctree::
7+
:maxdepth: 1
88

9-
Starring
10-
~~~~~~~~
119

12-
Watching
13-
~~~~~~~~
14-
15-
Events
16-
~~~~~~
17-
18-
Feeds
19-
~~~~~
10+
activity/events
11+
activity/event-types
12+
activity/feeds
13+
activity/notifications
14+
activity/starring
15+
activity/watching

‎docs/gh/activity/event-types.rst

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
Event Types
2+
-----------
3+
4+
`http://developer.github.com/v3/activity/events/types/ <http://developer.github.com/v3/activity/events/types/>`_
5+
6+
7+
CommitCommentEvent
8+
~~~~~~~~~~~~~~~~~~
9+
10+
`http://developer.github.com/v3/activity/events/types/#commitcommentevent <http://developer.github.com/v3/activity/events/types/#commitcommentevent>`_
11+
12+
CreateEvent
13+
~~~~~~~~~~~
14+
15+
`http://developer.github.com/v3/activity/events/types/#createevent <http://developer.github.com/v3/activity/events/types/#createevent>`_
16+
17+
DeleteEvent
18+
~~~~~~~~~~~
19+
20+
`http://developer.github.com/v3/activity/events/types/#deleteevent <http://developer.github.com/v3/activity/events/types/#deleteevent>`_
21+
22+
DeploymentEvent
23+
~~~~~~~~~~~~~~~
24+
25+
`http://developer.github.com/v3/activity/events/types/#deploymentevent <http://developer.github.com/v3/activity/events/types/#deploymentevent>`_
26+
27+
DeploymentStatusEvent
28+
~~~~~~~~~~~~~~~~~~~~~
29+
30+
`http://developer.github.com/v3/activity/events/types/#deploymentstatusevent <http://developer.github.com/v3/activity/events/types/#deploymentstatusevent>`_
31+
32+
DownloadEvent
33+
~~~~~~~~~~~~~
34+
35+
`http://developer.github.com/v3/activity/events/types/#downloadevent <http://developer.github.com/v3/activity/events/types/#downloadevent>`_
36+
37+
FollowEvent
38+
~~~~~~~~~~~
39+
40+
`http://developer.github.com/v3/activity/events/types/#followevent <http://developer.github.com/v3/activity/events/types/#followevent>`_
41+
42+
ForkEvent
43+
~~~~~~~~~
44+
45+
`http://developer.github.com/v3/activity/events/types/#forkevent <http://developer.github.com/v3/activity/events/types/#forkevent>`_
46+
47+
ForkApplyEvent
48+
~~~~~~~~~~~~~~
49+
50+
`http://developer.github.com/v3/activity/events/types/#forkapplyevent <http://developer.github.com/v3/activity/events/types/#forkapplyevent>`_
51+
52+
GistEvent
53+
~~~~~~~~~
54+
55+
`http://developer.github.com/v3/activity/events/types/#gistevent <http://developer.github.com/v3/activity/events/types/#gistevent>`_
56+
57+
GollumEvent
58+
~~~~~~~~~~~
59+
60+
`http://developer.github.com/v3/activity/events/types/#gollumevent <http://developer.github.com/v3/activity/events/types/#gollumevent>`_
61+
62+
IssueCommentEvent
63+
~~~~~~~~~~~~~~~~~
64+
65+
`http://developer.github.com/v3/activity/events/types/#issuecommentevent <http://developer.github.com/v3/activity/events/types/#issuecommentevent>`_
66+
67+
IssuesEvent
68+
~~~~~~~~~~~
69+
70+
`http://developer.github.com/v3/activity/events/types/#issuesevent <http://developer.github.com/v3/activity/events/types/#issuesevent>`_
71+
72+
MemberEvent
73+
~~~~~~~~~~~
74+
75+
`http://developer.github.com/v3/activity/events/types/#memberevent <http://developer.github.com/v3/activity/events/types/#memberevent>`_
76+
77+
PublicEvent
78+
~~~~~~~~~~~
79+
80+
`http://developer.github.com/v3/activity/events/types/#publicevent <http://developer.github.com/v3/activity/events/types/#publicevent>`_
81+
82+
PullRequestEvent
83+
~~~~~~~~~~~~~~~~
84+
85+
`http://developer.github.com/v3/activity/events/types/#pullrequestevent <http://developer.github.com/v3/activity/events/types/#pullrequestevent>`_
86+
87+
PullRequestReviewCommentEvent
88+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
89+
90+
`http://developer.github.com/v3/activity/events/types/#pullrequestreviewcommentevent <http://developer.github.com/v3/activity/events/types/#pullrequestreviewcommentevent>`_
91+
92+
PushEvent
93+
~~~~~~~~~
94+
95+
`http://developer.github.com/v3/activity/events/types/#pushevent <http://developer.github.com/v3/activity/events/types/#pushevent>`_
96+
97+
ReleaseEvent
98+
~~~~~~~~~~~~
99+
100+
`http://developer.github.com/v3/activity/events/types/#releaseevent <http://developer.github.com/v3/activity/events/types/#releaseevent>`_
101+
102+
StatusEvent
103+
~~~~~~~~~~~
104+
105+
`http://developer.github.com/v3/activity/events/types/#statusevent <http://developer.github.com/v3/activity/events/types/#statusevent>`_
106+
107+
TeamAddEvent
108+
~~~~~~~~~~~~
109+
110+
`http://developer.github.com/v3/activity/events/types/#teamaddevent <http://developer.github.com/v3/activity/events/types/#teamaddevent>`_
111+
112+
WatchEvent
113+
~~~~~~~~~~
114+
115+
`http://developer.github.com/v3/activity/events/types/#watchevent <http://developer.github.com/v3/activity/events/types/#watchevent>`_

‎docs/gh/activity/events.rst

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
Events
2+
------
3+
4+
`http://developer.github.com/v3/activity/events/ <http://developer.github.com/v3/activity/events/>`_
5+
6+
7+
8+
List public events
9+
~~~~~~~~~~~~~~~~~~
10+
11+
`http://developer.github.com/v3/activity/events/#list-public-events <http://developer.github.com/v3/activity/events/#list-public-events>`_
12+
13+
List repository events
14+
~~~~~~~~~~~~~~~~~~~~~~
15+
16+
`http://developer.github.com/v3/activity/events/#list-repository-events <http://developer.github.com/v3/activity/events/#list-repository-events>`_
17+
18+
List issue events for a repository
19+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20+
21+
`http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository <http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository>`_
22+
23+
List public events for a network of repositories
24+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
25+
26+
`http://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories <http://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories>`_
27+
28+
List public events for an organization
29+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
30+
31+
`http://developer.github.com/v3/activity/events/#list-public-events-for-an-organization <http://developer.github.com/v3/activity/events/#list-public-events-for-an-organization>`_
32+
33+
List events that a user has received
34+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35+
36+
`http://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received <http://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received>`_
37+
38+
List public events that a user has received
39+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
40+
41+
`http://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received <http://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received>`_
42+
43+
List events performed by a user
44+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
45+
46+
`http://developer.github.com/v3/activity/events/#list-events-performed-by-a-user <http://developer.github.com/v3/activity/events/#list-events-performed-by-a-user>`_
47+
48+
List public events performed by a user
49+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
50+
51+
`http://developer.github.com/v3/activity/events/#list-public-events-performed-by-a-user <http://developer.github.com/v3/activity/events/#list-public-events-performed-by-a-user>`_
52+
53+
List events for an organization
54+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
55+
56+
`http://developer.github.com/v3/activity/events/#list-events-for-an-organization <http://developer.github.com/v3/activity/events/#list-events-for-an-organization>`_
57+

‎docs/gh/activity/feeds.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Feeds
2+
-----
3+
4+
`http://developer.github.com/v3/activity/feeds/ <http://developer.github.com/v3/activity/feeds/>`_
5+
6+
List Feeds
7+
~~~~~~~~~~
8+
9+
`http://developer.github.com/v3/activity/feeds/#list-feeds <http://developer.github.com/v3/activity/feeds/#list-feeds>`_
10+
11+

‎docs/gh/activity/notifications.rst

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
Notifications
2+
-------------
3+
4+
`http://developer.github.com/v3/activity/notifications/ <http://developer.github.com/v3/activity/notifications/>`_
5+
6+
7+
Notification Reasons
8+
~~~~~~~~~~~~~~~~~~~~
9+
10+
`http://developer.github.com/v3/activity/notifications/#notification-reasons <http://developer.github.com/v3/activity/notifications/#notification-reasons>`_
11+
12+
List your notifications
13+
~~~~~~~~~~~~~~~~~~~~~~~
14+
15+
`http://developer.github.com/v3/activity/notifications/#list-your-notifications <http://developer.github.com/v3/activity/notifications/#list-your-notifications>`_
16+
17+
List your notifications in a repository
18+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
19+
20+
`http://developer.github.com/v3/activity/notifications/#list-your-notifications-in-a-repository <http://developer.github.com/v3/activity/notifications/#list-your-notifications-in-a-repository>`_
21+
22+
Mark as read
23+
~~~~~~~~~~~~
24+
25+
`http://developer.github.com/v3/activity/notifications/#mark-as-read <http://developer.github.com/v3/activity/notifications/#mark-as-read>`_
26+
27+
Mark notifications as read in a repository
28+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
29+
30+
`http://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository <http://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository>`_
31+
32+
View a single thread
33+
~~~~~~~~~~~~~~~~~~~~
34+
35+
`http://developer.github.com/v3/activity/notifications/#view-a-single-thread <http://developer.github.com/v3/activity/notifications/#view-a-single-thread>`_
36+
37+
Mark a thread as read
38+
~~~~~~~~~~~~~~~~~~~~~
39+
40+
`http://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read <http://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read>`_
41+
42+
Get a Thread Subscription
43+
~~~~~~~~~~~~~~~~~~~~~~~~~
44+
45+
`http://developer.github.com/v3/activity/notifications/#get-a-thread-subscription <http://developer.github.com/v3/activity/notifications/#get-a-thread-subscription>`_
46+
47+
Set a Thread Subscription
48+
~~~~~~~~~~~~~~~~~~~~~~~~~
49+
50+
`http://developer.github.com/v3/activity/notifications/#set-a-thread-subscription <http://developer.github.com/v3/activity/notifications/#set-a-thread-subscription>`_
51+
52+
Delete a Thread Subscription
53+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
54+
55+
`http://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription <http://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription>`_

‎docs/gh/activity/starring.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
Starring
2+
--------
3+
4+
5+
`http://developer.github.com/v3/activity/starring/ <http://developer.github.com/v3/activity/starring/>`_
6+
7+
8+
List Stargazers
9+
~~~~~~~~~~~~~~~
10+
11+
`http://developer.github.com/v3/activity/starring/#list-stargazers <http://developer.github.com/v3/activity/starring/#list-stargazers>`_
12+
13+
List repositories being starred
14+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15+
16+
`http://developer.github.com/v3/activity/starring/#list-repositories-being-starred <http://developer.github.com/v3/activity/starring/#list-repositories-being-starred>`_
17+
18+
Check if you are starring a repository
19+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20+
21+
`http://developer.github.com/v3/activity/starring/#check-if-you-are-starring-a-repository <http://developer.github.com/v3/activity/starring/#check-if-you-are-starring-a-repository>`_
22+
23+
Star a repository
24+
~~~~~~~~~~~~~~~~~
25+
26+
`http://developer.github.com/v3/activity/starring/#star-a-repository <http://developer.github.com/v3/activity/starring/#star-a-repository>`_
27+
28+
Unstar a repository
29+
~~~~~~~~~~~~~~~~~~~
30+
31+
`http://developer.github.com/v3/activity/starring/#unstar-a-repository <http://developer.github.com/v3/activity/starring/#unstar-a-repository>`_

‎docs/gh/activity/watching.rst

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
Watching
2+
--------
3+
4+
5+
`http://developer.github.com/v3/activity/starring/#unstar-a-repository <http://developer.github.com/v3/activity/starring/#unstar-a-repository>`_
6+
7+
8+
9+
List watchers
10+
~~~~~~~~~~~~~
11+
12+
`http://developer.github.com/v3/activity/watching/#list-watchers <http://developer.github.com/v3/activity/watching/#list-watchers>`_
13+
14+
List repositories being watched
15+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16+
17+
`http://developer.github.com/v3/activity/watching/#list-repositories-being-watched <http://developer.github.com/v3/activity/watching/#list-repositories-being-watched>`_
18+
19+
Get a Repository Subscription
20+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
21+
22+
`http://developer.github.com/v3/activity/watching/#get-a-repository-subscription <http://developer.github.com/v3/activity/watching/#get-a-repository-subscription>`_
23+
24+
Set a Repository Subscription
25+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26+
27+
`http://developer.github.com/v3/activity/watching/#set-a-repository-subscription <http://developer.github.com/v3/activity/watching/#set-a-repository-subscription>`_
28+
29+
Delete a Repository Subscription
30+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
31+
32+
`http://developer.github.com/v3/activity/watching/#delete-a-repository-subscription <http://developer.github.com/v3/activity/watching/#delete-a-repository-subscription>`_
33+
34+
Check if you are watching a repository (LEGACY)
35+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36+
37+
`http://developer.github.com/v3/activity/watching/#check-if-you-are-watching-a-repository-legacy <http://developer.github.com/v3/activity/watching/#check-if-you-are-watching-a-repository-legacy>`_
38+
39+
Watch a repository (LEGACY)
40+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
41+
42+
`http://developer.github.com/v3/activity/watching/#watch-a-repository-legacy <http://developer.github.com/v3/activity/watching/#watch-a-repository-legacy>`_
43+
44+
Stop watching a repository (LEGACY)
45+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
46+
47+
`http://developer.github.com/v3/activity/watching/#stop-watching-a-repository-legacy <http://developer.github.com/v3/activity/watching/#stop-watching-a-repository-legacy>`_
48+

0 commit comments

Comments
 (0)
0