Add extra_funcs to documentation

This commit is contained in:
Andrew Smirnov 2021-02-11 20:04:08 +03:00
parent 8024d38e09
commit c3f9e6626b
No known key found for this signature in database
GPG Key ID: 0EFE318E5BB2A82A
4 changed files with 24 additions and 4 deletions

9
docs/source/code.rst Normal file
View File

@ -0,0 +1,9 @@
*****
TODOs
*****
Extra Functions
---------------
.. automodule:: main.extra_func
:members:

View File

@ -6,10 +6,13 @@
Welcome to ZenDesk Access Controller's documentation! Welcome to ZenDesk Access Controller's documentation!
===================================================== =====================================================
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents:
code.rst
todo.rst
Indices and tables Indices and tables

5
docs/source/todo.rst Normal file
View File

@ -0,0 +1,5 @@
*****
TODOs
*****
.. todolist::

View File

@ -7,10 +7,13 @@ from main.models import UserProfile
# Дополнительные функции # Дополнительные функции
def set_and_get_name(UP: UserProfile): # TODO: Переделать с получением данных через API def set_and_get_name(UP: UserProfile):
""" """
Функция устанавливает поле :class:`username` текущим именем в Zendesk Функция устанавливает поле :class:`username` текущим именем в Zendesk
.. TODO::
Переделать с получением данных через API
:param UP: Объект профиля пользователя :param UP: Объект профиля пользователя
:type UP: :class:`main.models.UserProfile` :type UP: :class:`main.models.UserProfile`
:return: Имя пользователя :return: Имя пользователя
@ -60,9 +63,9 @@ def check_user_exist(email: str) -> bool:
Функция проверяет, существует ли пользователь Функция проверяет, существует ли пользователь
:param email: Электронная почта пользователя :param email: Электронная почта пользователя
:type email: :class:`str :type email: :class:`str`
:return: True, если существует, иначе False :return: True, если существует, иначе False
:rtype: :class:`bool' :rtype: :class:`bool`
""" """
admin_creds = { admin_creds = {
'email': os.environ.get('Admin_email'), 'email': os.environ.get('Admin_email'),
@ -85,7 +88,7 @@ def check_user_auth(email: str, password: str) -> bool:
:param password: Пароль пользователя :param password: Пароль пользователя
:type password: :class:`str` :type password: :class:`str`
:return: True, если входные данные верны, иначе False :return: True, если входные данные верны, иначе False
:raise APIException: исключение, вызываемое если пользователь не аутентифицирован :raise :class:`APIException`: исключение, вызываемое если пользователь не аутентифицирован
:rtype: :class:`bool` :rtype: :class:`bool`
""" """
try: try: