docs: basic wiring in of communities documentation

This commit is contained in:
Peter Williams 2020-03-26 19:25:35 -04:00
Родитель 6e15d3a5fa
Коммит 11cd27a47c
5 изменённых файлов: 53 добавлений и 0 удалений

Просмотреть файл

@ -4,3 +4,7 @@ API Documentation
.. automodapi:: wwt_api_client
:no-inheritance-diagram:
:no-inherited-members:
.. automodapi:: wwt_api_client.communities
:no-inheritance-diagram:
:no-inherited-members:

Просмотреть файл

@ -0,0 +1,7 @@
CommunitiesAPIRequest
=====================
.. currentmodule:: wwt_api_client.communities
.. autoclass:: CommunitiesAPIRequest
:show-inheritance:

Просмотреть файл

@ -0,0 +1,17 @@
CommunitiesClient
=================
.. currentmodule:: wwt_api_client.communities
.. autoclass:: CommunitiesClient
:show-inheritance:
.. rubric:: Methods Summary
.. autosummary::
~CommunitiesClient.is_user_registered
.. rubric:: Methods Documentation
.. automethod:: is_user_registered

Просмотреть файл

@ -0,0 +1,19 @@
IsUserRegisteredRequest
=======================
.. currentmodule:: wwt_api_client.communities
.. autoclass:: IsUserRegisteredRequest
:show-inheritance:
.. rubric:: Methods Summary
.. autosummary::
~IsUserRegisteredRequest.invalidity_reason
~IsUserRegisteredRequest.make_request
.. rubric:: Methods Documentation
.. automethod:: invalidity_reason
.. automethod:: make_request

Просмотреть файл

@ -0,0 +1,6 @@
interactive_communities_login
=============================
.. currentmodule:: wwt_api_client.communities
.. autofunction:: interactive_communities_login