Skip to content

Commit a326a69

Browse files
cmlcciecmlccie
committed
Docs update
- Move the API structure table to its own file. - Add the API structure table to the User API Doc. - Configure Sphinx not to add module names to references.
1 parent fc112f1 commit a326a69

File tree

5 files changed

+67
-54
lines changed

5 files changed

+67
-54
lines changed

‎docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
pygments_style = 'sphinx'
3737

3838

39+
add_module_names = False
3940
autodoc_member_order = 'bysource'
4041
# autodoc_default_flags = ['members', 'undoc-members']
4142
autodoc_default_options = {

‎docs/user/api.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,15 @@ User API Doc
1010
WebexTeamsAPI
1111
=============
1212

13-
The :class:`WebexTeamsAPI` class is the main interface for the package. All of
14-
the Webex Teams APIs (people, rooms, etc.) and their API endpoints have been wrapped
15-
and hierarchically organized underneath the :class:`WebexTeamsAPI` class.
13+
The :class:`WebexTeamsAPI` class creates "connection objects" for working with the Webex Teams APIs and hierarchically organizes the Webex Teams APIs and their endpoints underneath these connection objects.
14+
15+
16+
.. include:: api_structure_table.rst
17+
1618

1719
.. autoclass:: WebexTeamsAPI()
1820
:members:
19-
:exclude-members: access_token, base_url, timeout
21+
:exclude-members: access_token, base_url
2022

2123
.. automethod:: WebexTeamsAPI.__init__
2224

‎docs/user/api_structure_table.rst

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
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+
+-----------------------+-------------------------+---------------------------------------------------------------------------------+

‎docs/user/quickstart.rst

Lines changed: 3 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ ready to start making API calls.
149149
It really is that easy.
150150

151151
All of the calls have been wrapped and represented as native Python method
152-
calls, like :meth:`WebexTeamsAPI.people.me()` which gets the person details
152+
calls, like :meth:`WebexTeamsAPI.people.me() <webexteamssdk.api.people.PeopleAPI.me>` which gets the person details
153153
for the authenticated user (the user who's access token you are using) - see
154154
the `https://api.ciscospark.com/v1/people/me
155155
<https://developer.webex.com/endpoint-people-me-get.html>`_ API endpoint
@@ -165,31 +165,8 @@ parameters, is available in the :ref:`User API Doc`, and a brief summary of the
165165
structure is provided here.
166166

167167

168-
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
169-
|:class:`WebexTeamsAPI` | :ref:`people` | :meth:`~PeopleAPI.list` :meth:`~PeopleAPI.create` :meth:`~PeopleAPI.get` :meth:`~PeopleAPI.update` :meth:`~PeopleAPI.me` |
170-
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
171-
| | :ref:`rooms` | :meth:`~RoomsAPI.list` :meth:`~RoomsAPI.create` :meth:`~RoomsAPI.get` :meth:`~RoomsAPI.update` :meth:`~RoomsAPI.delete` |
172-
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
173-
| | :ref:`memberships` | :meth:`~MembershipsAPI.list` :meth:`~MembershipsAPI.create` :meth:`~MembershipsAPI.get` :meth:`~MembershipsAPI.update` :meth:`~MembershipsAPI.delete` |
174-
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
175-
| | :ref:`messages` | :meth:`~MessagesAPI.list` :meth:`~MessagesAPI.create` :meth:`~MessagesAPI.get` :meth:`~MessagesAPI.delete` |
176-
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
177-
| | :ref:`teams` | :meth:`~TeamsAPI.list` :meth:`~TeamsAPI.create` :meth:`~TeamsAPI.get` :meth:`~TeamsAPI.update` :meth:`~TeamsAPI.delete` |
178-
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
179-
| | :ref:`team_memberships` | :meth:`~TeamMembershipsAPI.list` :meth:`~TeamMembershipsAPI.create` :meth:`~TeamMembershipsAPI.get` :meth:`~TeamMembershipsAPI.update` :meth:`~TeamMembershipsAPI.delete` |
180-
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
181-
| | :ref:`webhooks` | :meth:`~WebhooksAPI.list` :meth:`~WebhooksAPI.create` :meth:`~WebhooksAPI.get` :meth:`~WebhooksAPI.update` :meth:`~WebhooksAPI.delete` |
182-
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
183-
| | :ref:`organizations` | :meth:`~OrganizationsAPI.list` :meth:`~OrganizationsAPI.create` |
184-
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
185-
| | :ref:`licenses` | :meth:`~LicensesAPI.list` :meth:`~LicensesAPI.create` |
186-
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
187-
| | :ref:`roles` | :meth:`~RolesAPI.list` :meth:`~RolesAPI.create` |
188-
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
189-
| | :ref:`events` | :meth:`~EventsAPI.list` :meth:`~EventsAPI.get` |
190-
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
191-
| | :ref:`access_tokens` | :meth:`~AccessTokensAPI.get` :meth:`~AccessTokensAPI.refresh` |
192-
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
168+
.. include:: api_structure_table.rst
169+
193170

194171
You can easily access and call any of these methods directly from your
195172
:class:`WebexTeamsAPI` connection object:

‎webexteamssdk/api/__init__.py

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -56,30 +56,6 @@ class WebexTeamsAPI(object):
5656
5757
WebexTeamsAPI wraps all of the individual Webex Teams APIs and represents
5858
them in a simple hierarchical structure.
59-
60-
:WebexTeamsAPI: :class:`people <PeopleAPI>`
61-
62-
:class:`rooms <RoomsAPI>`
63-
64-
:class:`memberships <MembershipsAPI>`
65-
66-
:class:`messages <MessagesAPI>`
67-
68-
:class:`teams <TeamsAPI>`
69-
70-
:class:`team_memberships <TeamMembershipsAPI>`
71-
72-
:class:`webhooks <WebhooksAPI>`
73-
74-
:class:`organizations <OrganizationsAPI>`
75-
76-
:class:`licenses <LicensesAPI>`
77-
78-
:class:`roles <RolesAPI>`
79-
80-
:class:`events <EventsAPI>`
81-
82-
:class:`access_tokens <AccessTokensAPI>`
8359
"""
8460

8561
def __init__(self, access_token=None, base_url=DEFAULT_BASE_URL,

0 commit comments

Comments
 (0)