8000 Allow unqualified Sphinx refs within modules of subpackages · davidmoss/github3.py@55698cc · GitHub
[go: up one dir, main page]
Skip to content
8000

Commit 55698cc

Browse files
bgilbertbgilbert
committed
Allow unqualified Sphinx refs within modules of subpackages
1 parent 2fa966f commit 55698cc

File tree

3 files changed

+65
-23
lines changed

3 files changed

+65
-23
lines changed

‎docs/gists.rst

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,28 @@ classes should never be instantiated by the user (developer) directly.
1717
Gist Objects
1818
------------
1919

20-
.. autoclass:: github3.gists.gist.Gist
20+
.. module:: github3.gists.gist
21+
22+
.. autoclass:: Gist
2123
:inherited-members:
2224

2325
------
2426

25-
.. autoclass:: github3.gists.comment.GistComment
27+
.. module:: github3.gists.comment
28+
29+
.. autoclass:: GistComment
2630
:inherited-members:
2731

2832
------
2933

30-
.. autoclass:: github3.gists.file.GistFile
34+
.. module:: github3.gists.file
35+
36+
.. autoclass:: GistFile
3137
:inherited-members:
3238

3339
------
3440

35-
.. autoclass:: github3.gists.history.GistHistory
41+
.. module:: github3.gists.history
42+
43+
.. autoclass:: GistHistory
3644
:inherited-members:

‎docs/issues.rst

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,25 +14,35 @@ This part of the documentation covers the module which handles :class:`Issue
1414
Issue Objects
1515
-------------
1616

17-
.. autoclass:: github3.issues.issue.Issue
17+
.. module:: github3.issues.issue
18+
19+
.. autoclass:: Issue
1820
:inherited-members:
1921

2022
------
2123

22-
.. autoclass:: github3.issues.comment.IssueComment
24+
.. module:: github3.issues.comment
25+
26+
.. autoclass:: IssueComment
2327
:inherited-members:
2428

2529
------
2630

27-
.. autoclass:: github3.issues.event.IssueEvent
31+
.. module:: github3.issues.event
32+
33+
.. autoclass:: IssueEvent
2834
:inherited-members:
2935

3036
------
3137

32-
.. autoclass:: github3.issues.milestone.Milestone
38+
.. module:: github3.issues.milestone
39+
40+
.. autoclass:: Milestone
3341
:inherited-members:
3442

3543
------
3644

37-
.. autoclass:: github3.issues.label.Label
45+
.. module:: github3.issues.label
46+
47+
.. autoclass:: Label
3848
:inherited-members:

‎docs/repos.rst

Lines changed: 38 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -35,73 +35,97 @@ sections of the GitHub documentation.
3535
Repository Objects
3636
------------------
3737

38-
.. autoclass:: github3.repos.repo.Repository
38+
.. module:: github3.repos.repo
39+
40+
.. autoclass:: Repository
3941
:inherited-members:
4042

4143
---------
4244

43-
.. autoclass:: github3.repos.branch.Branch
45+
.. module:: github3.repos.branch
46+
47+
.. autoclass:: Branch
4448
:members:
4549

4650
---------
4751

48-
.. autoclass:: github3.repos.contents.Contents
52+
.. module:: github3.repos.contents
53+
54+
.. autoclass:: Contents
4955
:members:
5056

5157
---------
5258

53-
.. autoclass:: github3.repos.deployment.Deployment
59+
.. module:: github3.repos.deployment
60+
61+
.. autoclass:: Deployment
5462
:members:
5563

5664
---------
5765

58-
.. autoclass:: github3.repos.deployment.DeploymentStatus
66+
.. autoclass:: DeploymentStatus
5967
:members:
6068

6169
---------
6270

63-
.. autoclass:: github3.repos.release.Release
71+
.. module:: github3.repos.release
72+
73+
.. autoclass:: Release
6474
:members:
6575

6676
---------
6777

68-
.. autoclass:: github3.repos.release.Asset
78+
.. autoclass:: Asset
6979
:members:
7080

7181
---------
7282

73-
.. autoclass:: github3.repos.hook.Hook
83+
.. module:: github3.repos.hook
84+
85+
.. autoclass:: Hook
7486
:members:
7587

7688
---------
7789

78-
.. autoclass:: github3.repos.tag.RepoTag
90+
.. module:: github3.repos.tag
91+
92+
.. autoclass:: RepoTag
7993
:members:
8094

8195
---------
8296

97+
.. module:: github3.repos.comment
98+
8399
More information about this class can be found in the official documentation
84100
about `comments <http://developer.github.com/v3/repos/comments/>`_.
85101

86-
.. autoclass:: github3.repos.comment.RepoComment
102+
.. autoclass:: RepoComment
87103
:inherited-members:
88104

89105
---------
90106

91-
.. autoclass:: github3.repos.commit.RepoCommit
107+
.. module:: github3.repos.commit
108+
109+
.. autoclass:: RepoCommit
92110
:members:
93111

94112
---------
95113

96-
.. autoclass:: github3.repos.comparison.Comparison
114+
.. module:: github3.repos.comparison
115+
116+
.. autoclass:: Comparison
97117
:members:
98118

99119
---------
100120

101-
.. autoclass:: github3.repos.status.Status
121+
.. module:: github3.repos.status
122+
123+
.. autoclass:: Status
102124
:members:
103125

104126
---------
105127

106-
.. autoclass:: github3.repos.stats.ContributorStats
128+
.. module:: github3.repos.stats
129+
130+
.. autoclass:: ContributorStats
107131
:members:

0 commit comments

Comments
 (0)
0