Add apiauth and serializers docs

docs/source/code.rst

@@ -26,6 +26,22 @@ Extra Functions
    :members:
 
 
+***************
+Serializers
+***************
+
+.. automodule:: main.serializers
+   :members:
+
+
+***************
+API functions
+***************
+
+.. automodule:: main.apiauth
+   :members:
+
+
 *****
 Views
 *****

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'
     }

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:

main/views.py

@@ -37,7 +37,7 @@ from .models import UserProfile
 
 class CustomRegistrationView(RegistrationView):
     """
-    Отображение и логика работы страницы регистрации пользователя
+    Отображение и логика работы страницы регистрации пользователя.
 
     :param form_class: Форма, которую необходимо заполнить для регистрации
     :type form_class: :class:`forms.CustomRegistrationForm`