From 0413a2edafec3c018531a07717aef56282d84625 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=D0=A1=D1=82=D0=B5=D0=BF=D0=B0=D0=BD=D0=B5=D0=BD=D0=BA?=
 =?UTF-8?q?=D0=BE=20=D0=9E=D0=BB=D1=8C=D0=B3=D0=B0?=
 <stepanenko_olga@mail.ru>
Date: Tue, 23 Mar 2021 20:55:30 +0300
Subject: [PATCH] Add apiauth and serializers docs

---
 docs/source/code.rst | 16 ++++++++++++++++
 main/apiauth.py      | 11 ++++++++++-
 main/serializers.py  |  6 ++++++
 main/views.py        |  2 +-
 4 files changed, 33 insertions(+), 2 deletions(-)

diff --git a/docs/source/code.rst b/docs/source/code.rst
index 7c5a05d..65539a7 100644
--- a/docs/source/code.rst
+++ b/docs/source/code.rst
@@ -26,6 +26,22 @@ Extra Functions
    :members:
 
 
+***************
+Serializers
+***************
+
+.. automodule:: main.serializers
+   :members:
+
+
+***************
+API functions
+***************
+
+.. automodule:: main.apiauth
+   :members:
+
+
 *****
 Views
 *****
diff --git a/main/apiauth.py b/main/apiauth.py
index 4e3f761..c24e85f 100644
--- a/main/apiauth.py
+++ b/main/apiauth.py
@@ -4,7 +4,16 @@ from zenpy import Zenpy
 from zenpy.lib.api_objects import User as ZenpyUser
 
 
-def api_auth():
+def api_auth() -> dict:
+    """
+    Функция создания пользователя с использованием Zendesk API.
+
+    Получает из env Zendesk - email, token, password пользователя.
+    Если данные валидны и пользователь Zendesk с указанным email и токеном или паролем существует,
+    создается словарь данных пользователя, полученных через API c Zendesk.
+
+    :return: данные пользователя
+    """
     credentials = {
         'subdomain': 'ngenix1612197338'
     }
diff --git a/main/serializers.py b/main/serializers.py
index f72fc86..aae45a6 100644
--- a/main/serializers.py
+++ b/main/serializers.py
@@ -4,12 +4,18 @@ from main.models import UserProfile
 
 
 class UserSerializer(serializers.HyperlinkedModelSerializer):
+    """
+    Класс serializer для модели User.
+    """
     class Meta:
         model = User
         fields = ['email']
 
 
 class ProfileSerializer(serializers.HyperlinkedModelSerializer):
+    """
+    Класс serialiser для модель профиля пользователя.
+    """
     user = UserSerializer()
 
     class Meta:
diff --git a/main/views.py b/main/views.py
index 08a6f91..f1900a7 100644
--- a/main/views.py
+++ b/main/views.py
@@ -37,7 +37,7 @@ from .models import UserProfile
 
 class CustomRegistrationView(RegistrationView):
     """
-    Отображение и логика работы страницы регистрации пользователя
+    Отображение и логика работы страницы регистрации пользователя.
 
     :param form_class: Форма, которую необходимо заполнить для регистрации
     :type form_class: :class:`forms.CustomRegistrationForm`