Add extra_funcs to documentation
This commit is contained in:
parent
8024d38e09
commit
c3f9e6626b
9
docs/source/code.rst
Normal file
9
docs/source/code.rst
Normal file
@ -0,0 +1,9 @@
|
||||
*****
|
||||
TODOs
|
||||
*****
|
||||
|
||||
Extra Functions
|
||||
---------------
|
||||
|
||||
.. automodule:: main.extra_func
|
||||
:members:
|
@ -6,10 +6,13 @@
|
||||
Welcome to ZenDesk Access Controller's documentation!
|
||||
=====================================================
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
code.rst
|
||||
todo.rst
|
||||
|
||||
|
||||
Indices and tables
|
||||
|
5
docs/source/todo.rst
Normal file
5
docs/source/todo.rst
Normal file
@ -0,0 +1,5 @@
|
||||
*****
|
||||
TODOs
|
||||
*****
|
||||
|
||||
.. todolist::
|
@ -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
|
||||
|
||||
.. TODO::
|
||||
Переделать с получением данных через API
|
||||
|
||||
:param UP: Объект профиля пользователя
|
||||
:type UP: :class:`main.models.UserProfile`
|
||||
:return: Имя пользователя
|
||||
@ -60,9 +63,9 @@ def check_user_exist(email: str) -> bool:
|
||||
Функция проверяет, существует ли пользователь
|
||||
|
||||
:param email: Электронная почта пользователя
|
||||
:type email: :class:`str
|
||||
:type email: :class:`str`
|
||||
:return: True, если существует, иначе False
|
||||
:rtype: :class:`bool'
|
||||
:rtype: :class:`bool`
|
||||
"""
|
||||
admin_creds = {
|
||||
'email': os.environ.get('Admin_email'),
|
||||
@ -85,7 +88,7 @@ def check_user_auth(email: str, password: str) -> bool:
|
||||
:param password: Пароль пользователя
|
||||
:type password: :class:`str`
|
||||
:return: True, если входные данные верны, иначе False
|
||||
:raise APIException: исключение, вызываемое если пользователь не аутентифицирован
|
||||
:raise :class:`APIException`: исключение, вызываемое если пользователь не аутентифицирован
|
||||
:rtype: :class:`bool`
|
||||
"""
|
||||
try:
|
||||
|
Loading…
x
Reference in New Issue
Block a user