Skip to content

Commit 4400126

Browse files
cmlcciecmlccie
committed
Sort APIs in docs
1 parent 7ba504c commit 4400126

File tree

2 files changed

+109
-102
lines changed

2 files changed

+109
-102
lines changed

‎docs/user/api.rst

Lines changed: 50 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -23,60 +23,56 @@ The :class:`WebexTeamsAPI` class creates "connection objects" for working with t
2323
.. automethod:: WebexTeamsAPI.__init__
2424

2525

26-
.. _people:
26+
.. _access_tokens:
2727

28-
people
29-
------
28+
access_tokens
29+
-------------
3030

31-
.. autoclass:: webexteamssdk.api.people.PeopleAPI()
31+
.. autoclass:: webexteamssdk.api.access_tokens.AccessTokensAPI()
3232

3333

34-
.. _rooms:
3534

36-
rooms
37-
-----
3835

39-
.. autoclass:: webexteamssdk.api.rooms.RoomsAPI()
4036

4137

42-
.. _memberships:
38+
.. _events:
4339

44-
memberships
45-
-----------
40+
events
41+
------
4642

47-
.. autoclass:: webexteamssdk.api.memberships.MembershipsAPI()
43+
.. autoclass:: webexteamssdk.api.events.EventsAPI()
4844

4945

50-
.. _messages:
46+
.. _guest_issuer:
5147

52-
messages
53-
--------
48+
guest_issuer
49+
------------
5450

55-
.. autoclass:: webexteamssdk.api.messages.MessagesAPI()
51+
.. autoclass:: webexteamssdk.api.guest_issuer.GuestIssuerAPI()
5652

5753

58-
.. _teams:
54+
.. _licenses:
5955

60-
teams
61-
-----
56+
licenses
57+
--------
6258

63-
.. autoclass:: webexteamssdk.api.teams.TeamsAPI()
59+
.. autoclass:: webexteamssdk.api.licenses.LicensesAPI()
6460

6561

66-
.. _team_memberships:
62+
.. _memberships:
6763

68-
team_memberships
69-
----------------
64+
memberships
65+
-----------
7066

71-
.. autoclass:: webexteamssdk.api.team_memberships.TeamMembershipsAPI()
67+
.. autoclass:: webexteamssdk.api.memberships.MembershipsAPI()
7268

7369

74-
.. _webhooks:
70+
.. _messages:
7571

76-
webhooks
72+
messages
7773
--------
7874

79-
.. autoclass:: webexteamssdk.api.webhooks.WebhooksAPI()
75+
.. autoclass:: webexteamssdk.api.messages.MessagesAPI()
8076

8177

8278
.. _organizations:
@@ -87,12 +83,12 @@ organizations
8783
.. autoclass:: webexteamssdk.api.organizations.OrganizationsAPI()
8884

8985

90-
.. _licenses:
86+
.. _people:
9187

92-
licenses
93-
--------
88+
people
89+
------
9490

95-
.. autoclass:: webexteamssdk.api.licenses.LicensesAPI()
91+
.. autoclass:: webexteamssdk.api.people.PeopleAPI()
9692

9793

9894
.. _roles:
@@ -102,27 +98,38 @@ roles
10298

10399
.. autoclass:: webexteamssdk.api.roles.RolesAPI()
104100

105-
.. _events:
106101

107-
events
108-
------
102+
.. _rooms:
109103

110-
.. autoclass:: webexteamssdk.api.events.EventsAPI()
104+
rooms
105+
-----
111106

107+
.. autoclass:: webexteamssdk.api.rooms.RoomsAPI()
112108

113-
.. _access_tokens:
114109

115-
access_tokens
116-
-------------
110+
.. _team_memberships:
117111

118-
.. autoclass:: webexteamssdk.api.access_tokens.AccessTokensAPI()
112+
team_memberships
113+
----------------
119114

120-
.. _guest_issuer:
115+
.. autoclass:: webexteamssdk.api.team_memberships.TeamMembershipsAPI()
121116

122-
guest_issuer
123-
------------
124117

125-
.. autoclass:: webexteamssdk.api.guest_issuer.GuestIssuerAPI()
118+
.. _teams:
119+
120+
teams
121+
-----
122+
123+
.. autoclass:: webexteamssdk.api.teams.TeamsAPI()
124+
125+
126+
.. _webhooks:
127+
128+
webhooks
129+
--------
130+
131+
.. autoclass:: webexteamssdk.api.webhooks.WebhooksAPI()
132+
126133

127134
.. _Webex Teams Data Objects:
128135

‎docs/user/api_structure_table.rst

Lines changed: 59 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,59 @@
1-
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
2-
|:class:`WebexTeamsAPI` | :ref:`people` | :meth:`list() <webexteamssdk.api.people.PeopleAPI.list>` |
3-
| | | :meth:`create() <webexteamssdk.api.people.PeopleAPI.create>` |
4-
| | | :meth:`get() <webexteamssdk.api.people.PeopleAPI.get>` |
5-
| | | :meth:`update() <webexteamssdk.api.people.PeopleAPI.update>` |
6-
| | | :meth:`me() <webexteamssdk.api.people.PeopleAPI.me>` |
7-
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
8-
| | :ref:`rooms` | :meth:`list() <webeteamssdk.api.rooms.RoomsAPI.list>` |
9-
| | | :meth:`create() <webeteamssdk.api.rooms.RoomsAPI.create>` |
10-
| | | :meth:`get() <webeteamssdk.api.rooms.RoomsAPI.get>` |
11-
| | | :meth:`update() <webeteamssdk.api.rooms.RoomsAPI.update>` |
12-
| | | :meth:`delete() <webeteamssdk.api.rooms.RoomsAPI.delete>` |
13-
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
14-
| | :ref:`memberships` | :meth:`list() <webeteamssdk.api.memberships.MembershipsAPI.list>` |
15-
| | | :meth:`create() <webeteamssdk.api.memberships.MembershipsAPI.create>` |
16-
| | | :meth:`get() <webeteamssdk.api.memberships.MembershipsAPI.get>` |
17-
| | | :meth:`update() <webeteamssdk.api.memberships.MembershipsAPI.update>` |
18-
| | | :meth:`delete() <webeteamssdk.api.memberships.MembershipsAPI.delete>` |
19-
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
20-
| | :ref:`messages` | :meth:`list() <webeteamssdk.api.messages.MessagesAPI.list>` |
21-
| | | :meth:`create() <webeteamssdk.api.messages.MessagesAPI.create>` |
22-
| | | :meth:`get() <webeteamssdk.api.messages.MessagesAPI.get>` |
23-
| | | :meth:`delete() <webeteamssdk.api.messages.MessagesAPI.delete>` |
24-
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
25-
| | :ref:`teams` | :meth:`list() <webeteamssdk.api.teams.TeamsAPI.list>` |
26-
| | | :meth:`create() <webeteamssdk.api.teams.TeamsAPI.create>` |
27-
| | | :meth:`get() <webeteamssdk.api.teams.TeamsAPI.get>` |
28-
| | | :meth:`update() <webeteamssdk.api.teams.TeamsAPI.update>` |
29-
| | | :meth:`delete() <webeteamssdk.api.teams.TeamsAPI.delete>` |
30-
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
31-
| | :ref:`team_memberships` | :meth:`list() <webeteamssdk.api.team_memberships.TeamMembershipsAPI.list>` |
32-
| | | :meth:`create() <webeteamssdk.api.team_memberships.TeamMembershipsAPI.create>` |
33-
| | | :meth:`get() <webeteamssdk.api.team_memberships.TeamMembershipsAPI.get>` |
34-
| | | :meth:`update() <webeteamssdk.api.team_memberships.TeamMembershipsAPI.update>` |
35-
| | | :meth:`delete() <webeteamssdk.api.team_memberships.TeamMembershipsAPI.delete>` |
36-
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
37-
| | :ref:`webhooks` | :meth:`list() <webeteamssdk.api.webhooks.WebhooksAPI.list>` |
38-
| | | :meth:`create() <webeteamssdk.api.webhooks.WebhooksAPI.create>` |
39-
| | | :meth:`get() <webeteamssdk.api..WebhooksAPI.get>` |
40-
| | | :meth:`update() <webeteamssdk.api.webhooks.WebhooksAPI.update>` |
41-
| | | :meth:`delete() <webeteamssdk.api.webhooks.WebhooksAPI.delete>` |
42-
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
43-
| | :ref:`organizations` | :meth:`list() <webeteamssdk.api.organizations.OrganizationsAPI.list>` |
44-
| | | :meth:`create() <webeteamssdk.api.organizations.OrganizationsAPI.create>` |
45-
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
46-
| | :ref:`licenses` | :meth:`list() <webeteamssdk.api.licenses.LicensesAPI.list>` |
47-
| | | :meth:`create() <webeteamssdk.api.licenses.LicensesAPI.create>` |
48-
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
49-
| | :ref:`roles` | :meth:`list() <webeteamssdk.api.roles.RolesAPI.list>` |
50-
| | | :meth:`create() <webeteamssdk.api.roles.RolesAPI.create>` |
51-
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
52-
| | :ref:`events` | :meth:`list() <webeteamssdk.api.events.EventsAPI.list>` |
53-
| | | :meth:`get() <webeteamssdk.api.events.EventsAPI.get>` |
54-
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
55-
| | :ref:`access_tokens` | :meth:`get() <webeteamssdk.api.access_tokens.AccessTokensAPI.get>` |
56-
| | | :meth:`refresh() <webeteamssdk.api.access_tokens.AccessTokensAPI.refresh>` |
57-
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
58-
| | :ref:`guest_issuer` | :meth:`create() <webexteamssdk.api.guest_issuer.create>` |
59-
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
1+
+------------------------+---------------------------+---------------------------------------------------------------------------------+
2+
| :class:`WebexTeamsAPI` | :ref:`access_tokens` | :meth:`get() <webeteamssdk.api.access_tokens.AccessTokensAPI.get>` |
3+
| | | :meth:`refresh() <webeteamssdk.api.access_tokens.AccessTokensAPI.refresh>` |
4+
+------------------------+---------------------------+---------------------------------------------------------------------------------+
5+
| | :ref:`events` | :meth:`list() <webeteamssdk.api.events.EventsAPI.list>` |
6+
| | | :meth:`get() <webeteamssdk.api.events.EventsAPI.get>` |
7+
+------------------------+---------------------------+---------------------------------------------------------------------------------+
8+
| | :ref:`guest_issuer` | :meth:`create() <webexteamssdk.api.guest_issuer.create>` |
9+
+------------------------+---------------------------+---------------------------------------------------------------------------------+
10+
| | :ref:`licenses` | :meth:`list() <webeteamssdk.api.licenses.LicensesAPI.list>` |
11+
| | | :meth:`create() <webeteamssdk.api.licenses.LicensesAPI.create>` |
12+
+------------------------+---------------------------+---------------------------------------------------------------------------------+
13+
| | :ref:`memberships` | :meth:`list() <webeteamssdk.api.memberships.MembershipsAPI.list>` |
14+
| | | :meth:`create() <webeteamssdk.api.memberships.MembershipsAPI.create>` |
15+
| | | :meth:`get() <webeteamssdk.api.memberships.MembershipsAPI.get>` |
16+
| | | :meth:`update() <webeteamssdk.api.memberships.MembershipsAPI.update>` |
17+
| | | :meth:`delete() <webeteamssdk.api.memberships.MembershipsAPI.delete>` |
18+
+------------------------+---------------------------+---------------------------------------------------------------------------------+
19+
| | :ref:`messages` | :meth:`list() <webeteamssdk.api.messages.MessagesAPI.list>` |
20+
| | | :meth:`create() <webeteamssdk.api.messages.MessagesAPI.create>` |
21+
| | | :meth:`get() <webeteamssdk.api.messages.MessagesAPI.get>` |
22+
| | | :meth:`delete() <webeteamssdk.api.messages.MessagesAPI.delete>` |
23+
+------------------------+---------------------------+---------------------------------------------------------------------------------+
24+
| | :ref:`organizations` | :meth:`list() <webeteamssdk.api.organizations.OrganizationsAPI.list>` |
25+
| | | :meth:`create() <webeteamssdk.api.organizations.OrganizationsAPI.create>` |
26+
+------------------------+---------------------------+---------------------------------------------------------------------------------+
27+
| | :ref:`people` | :meth:`list() <webexteamssdk.api.people.PeopleAPI.list>` |
28+
| | | :meth:`create() <webexteamssdk.api.people.PeopleAPI.create>` |
29+
| | | :meth:`get() <webexteamssdk.api.people.PeopleAPI.get>` |
30+
| | | :meth:`update() <webexteamssdk.api.people.PeopleAPI.update>` |
31+
| | | :meth:`me() <webexteamssdk.api.people.PeopleAPI.me>` |
32+
+------------------------+---------------------------+---------------------------------------------------------------------------------+
33+
| | :ref:`roles` | :meth:`list() <webeteamssdk.api.roles.RolesAPI.list>` |
34+
| | | :meth:`create() <webeteamssdk.api.roles.RolesAPI.create>` |
35+
+------------------------+---------------------------+---------------------------------------------------------------------------------+
36+
| | :ref:`rooms` | :meth:`list() <webeteamssdk.api.rooms.RoomsAPI.list>` |
37+
| | | :meth:`create() <webeteamssdk.api.rooms.RoomsAPI.create>` |
38+
| | | :meth:`get() <webeteamssdk.api.rooms.RoomsAPI.get>` |
39+
| | | :meth:`update() <webeteamssdk.api.rooms.RoomsAPI.update>` |
40+
| | | :meth:`delete() <webeteamssdk.api.rooms.RoomsAPI.delete>` |
41+
+------------------------+---------------------------+---------------------------------------------------------------------------------+
42+
| | :ref:`team_memberships` | :meth:`list() <webeteamssdk.api.team_memberships.TeamMembershipsAPI.list>` |
43+
| | | :meth:`create() <webeteamssdk.api.team_memberships.TeamMembershipsAPI.create>` |
44+
| | | :meth:`get() <webeteamssdk.api.team_memberships.TeamMembershipsAPI.get>` |
45+
| | | :meth:`update() <webeteamssdk.api.team_memberships.TeamMembershipsAPI.update>` |
46+
| | | :meth:`delete() <webeteamssdk.api.team_memberships.TeamMembershipsAPI.delete>` |
47+
+------------------------+---------------------------+---------------------------------------------------------------------------------+
48+
| | :ref:`teams` | :meth:`list() <webeteamssdk.api.teams.TeamsAPI.list>` |
49+
| | | :meth:`create() <webeteamssdk.api.teams.TeamsAPI.create>` |
50+
| | | :meth:`get() <webeteamssdk.api.teams.TeamsAPI.get>` |
51+
| | | :meth:`update() <webeteamssdk.api.teams.TeamsAPI.update>` |
52+
| | | :meth:`delete() <webeteamssdk.api.teams.TeamsAPI.delete>` |
53+
+------------------------+---------------------------+---------------------------------------------------------------------------------+
54+
| | :ref:`webhooks` | :meth:`list() <webeteamssdk.api.webhooks.WebhooksAPI.list>` |
55+
| | | :meth:`create() <webeteamssdk.api.webhooks.WebhooksAPI.create>` |
56+
| | | :meth:`get() <webeteamssdk.api..WebhooksAPI.get>` |
57+
| | | :meth:`update() <webeteamssdk.api.webhooks.WebhooksAPI.update>` |
58+
| | | :meth:`delete() <webeteamssdk.api.webhooks.WebhooksAPI.delete>` |
59+
+------------------------+---------------------------+---------------------------------------------------------------------------------+

0 commit comments

Comments
 (0)