Skip to content

Commit

Permalink
Docs update
Browse files Browse the repository at this point in the history 
- 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.
  • Loading branch information
@cmlccie
cmlccie committed Sep 15, 2018
1 parent fc112f1 commit a326a69
Show file tree
Hide file tree
Showing 5 changed files with 67 additions and 54 deletions.
1 change: 1 addition & 0 deletions docs/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
pygments_style = 'sphinx'


add_module_names = False
autodoc_member_order = 'bysource'
# autodoc_default_flags = ['members', 'undoc-members']
autodoc_default_options = {
Expand Down
10 changes: 6 additions & 4 deletions docs/user/api.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,15 @@ User API Doc
WebexTeamsAPI
=============

The :class:`WebexTeamsAPI` class is the main interface for the package. All of
the Webex Teams APIs (people, rooms, etc.) and their API endpoints have been wrapped
and hierarchically organized underneath the :class:`WebexTeamsAPI` class.
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.


.. include:: api_structure_table.rst


.. autoclass:: WebexTeamsAPI()
:members:
:exclude-members: access_token, base_url, timeout
:exclude-members: access_token, base_url

.. automethod:: WebexTeamsAPI.__init__

Expand Down
57 changes: 57 additions & 0 deletions docs/user/api_structure_table.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
|:class:`WebexTeamsAPI` | :ref:`people` | :meth:`list() <webexteamssdk.api.people.PeopleAPI.list>` |
| | | :meth:`create() <webexteamssdk.api.people.PeopleAPI.create>` |
| | | :meth:`get() <webexteamssdk.api.people.PeopleAPI.get>` |
| | | :meth:`update() <webexteamssdk.api.people.PeopleAPI.update>` |
| | | :meth:`me() <webexteamssdk.api.people.PeopleAPI.me>` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
| | :ref:`rooms` | :meth:`list() <webeteamssdk.api.rooms.RoomsAPI.list>` |
| | | :meth:`create() <webeteamssdk.api.rooms.RoomsAPI.create>` |
| | | :meth:`get() <webeteamssdk.api.rooms.RoomsAPI.get>` |
| | | :meth:`update() <webeteamssdk.api.rooms.RoomsAPI.update>` |
| | | :meth:`delete() <webeteamssdk.api.rooms.RoomsAPI.delete>` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
| | :ref:`memberships` | :meth:`list() <webeteamssdk.api.memberships.MembershipsAPI.list>` |
| | | :meth:`create() <webeteamssdk.api.memberships.MembershipsAPI.create>` |
| | | :meth:`get() <webeteamssdk.api.memberships.MembershipsAPI.get>` |
| | | :meth:`update() <webeteamssdk.api.memberships.MembershipsAPI.update>` |
| | | :meth:`delete() <webeteamssdk.api.memberships.MembershipsAPI.delete>` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
| | :ref:`messages` | :meth:`list() <webeteamssdk.api.messages.MessagesAPI.list>` |
| | | :meth:`create() <webeteamssdk.api.messages.MessagesAPI.create>` |
| | | :meth:`get() <webeteamssdk.api.messages.MessagesAPI.get>` |
| | | :meth:`delete() <webeteamssdk.api.messages.MessagesAPI.delete>` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
| | :ref:`teams` | :meth:`list() <webeteamssdk.api.teams.TeamsAPI.list>` |
| | | :meth:`create() <webeteamssdk.api.teams.TeamsAPI.create>` |
| | | :meth:`get() <webeteamssdk.api.teams.TeamsAPI.get>` |
| | | :meth:`update() <webeteamssdk.api.teams.TeamsAPI.update>` |
| | | :meth:`delete() <webeteamssdk.api.teams.TeamsAPI.delete>` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
| | :ref:`team_memberships` | :meth:`list() <webeteamssdk.api.team_memberships.TeamMembershipsAPI.list>` |
| | | :meth:`create() <webeteamssdk.api.team_memberships.TeamMembershipsAPI.create>` |
| | | :meth:`get() <webeteamssdk.api.team_memberships.TeamMembershipsAPI.get>` |
| | | :meth:`update() <webeteamssdk.api.team_memberships.TeamMembershipsAPI.update>` |
| | | :meth:`delete() <webeteamssdk.api.team_memberships.TeamMembershipsAPI.delete>` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
| | :ref:`webhooks` | :meth:`list() <webeteamssdk.api.webhooks.WebhooksAPI.list>` |
| | | :meth:`create() <webeteamssdk.api.webhooks.WebhooksAPI.create>` |
| | | :meth:`get() <webeteamssdk.api..WebhooksAPI.get>` |
| | | :meth:`update() <webeteamssdk.api.webhooks.WebhooksAPI.update>` |
| | | :meth:`delete() <webeteamssdk.api.webhooks.WebhooksAPI.delete>` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
| | :ref:`organizations` | :meth:`list() <webeteamssdk.api.organizations.OrganizationsAPI.list>` |
| | | :meth:`create() <webeteamssdk.api.organizations.OrganizationsAPI.create>` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
| | :ref:`licenses` | :meth:`list() <webeteamssdk.api.licenses.LicensesAPI.list>` |
| | | :meth:`create() <webeteamssdk.api.licenses.LicensesAPI.create>` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
| | :ref:`roles` | :meth:`list() <webeteamssdk.api.roles.RolesAPI.list>` |
| | | :meth:`create() <webeteamssdk.api.roles.RolesAPI.create>` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
| | :ref:`events` | :meth:`list() <webeteamssdk.api.events.EventsAPI.list>` |
| | | :meth:`get() <webeteamssdk.api.events.EventsAPI.get>` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
| | :ref:`access_tokens` | :meth:`get() <webeteamssdk.api.access_tokens.AccessTokensAPI.get>` |
| | | :meth:`refresh() <webeteamssdk.api.access_tokens.AccessTokensAPI.refresh>` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------+
29 changes: 3 additions & 26 deletions docs/user/quickstart.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ ready to start making API calls.
It really is that easy.

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


+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|:class:`WebexTeamsAPI` | :ref:`people` | :meth:`~PeopleAPI.list` :meth:`~PeopleAPI.create` :meth:`~PeopleAPI.get` :meth:`~PeopleAPI.update` :meth:`~PeopleAPI.me` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | :ref:`rooms` | :meth:`~RoomsAPI.list` :meth:`~RoomsAPI.create` :meth:`~RoomsAPI.get` :meth:`~RoomsAPI.update` :meth:`~RoomsAPI.delete` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | :ref:`memberships` | :meth:`~MembershipsAPI.list` :meth:`~MembershipsAPI.create` :meth:`~MembershipsAPI.get` :meth:`~MembershipsAPI.update` :meth:`~MembershipsAPI.delete` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | :ref:`messages` | :meth:`~MessagesAPI.list` :meth:`~MessagesAPI.create` :meth:`~MessagesAPI.get` :meth:`~MessagesAPI.delete` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | :ref:`teams` | :meth:`~TeamsAPI.list` :meth:`~TeamsAPI.create` :meth:`~TeamsAPI.get` :meth:`~TeamsAPI.update` :meth:`~TeamsAPI.delete` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | :ref:`team_memberships` | :meth:`~TeamMembershipsAPI.list` :meth:`~TeamMembershipsAPI.create` :meth:`~TeamMembershipsAPI.get` :meth:`~TeamMembershipsAPI.update` :meth:`~TeamMembershipsAPI.delete` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | :ref:`webhooks` | :meth:`~WebhooksAPI.list` :meth:`~WebhooksAPI.create` :meth:`~WebhooksAPI.get` :meth:`~WebhooksAPI.update` :meth:`~WebhooksAPI.delete` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | :ref:`organizations` | :meth:`~OrganizationsAPI.list` :meth:`~OrganizationsAPI.create` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | :ref:`licenses` | :meth:`~LicensesAPI.list` :meth:`~LicensesAPI.create` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | :ref:`roles` | :meth:`~RolesAPI.list` :meth:`~RolesAPI.create` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | :ref:`events` | :meth:`~EventsAPI.list` :meth:`~EventsAPI.get` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | :ref:`access_tokens` | :meth:`~AccessTokensAPI.get` :meth:`~AccessTokensAPI.refresh` |
+-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. include:: api_structure_table.rst


You can easily access and call any of these methods directly from your
:class:`WebexTeamsAPI` connection object:
Expand Down
24 changes: 0 additions & 24 deletions webexteamssdk/api/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,30 +56,6 @@ class WebexTeamsAPI(object):
WebexTeamsAPI wraps all of the individual Webex Teams APIs and represents
them in a simple hierarchical structure.
:WebexTeamsAPI: :class:`people <PeopleAPI>`
:class:`rooms <RoomsAPI>`
:class:`memberships <MembershipsAPI>`
:class:`messages <MessagesAPI>`
:class:`teams <TeamsAPI>`
:class:`team_memberships <TeamMembershipsAPI>`
:class:`webhooks <WebhooksAPI>`
:class:`organizations <OrganizationsAPI>`
:class:`licenses <LicensesAPI>`
:class:`roles <RolesAPI>`
:class:`events <EventsAPI>`
:class:`access_tokens <AccessTokensAPI>`
"""

def __init__(self, access_token=None, base_url=DEFAULT_BASE_URL,
Expand Down

0 comments on commit a326a69

Please sign in to comment.