diff --git a/docs/source/code.rst b/docs/source/code.rst index 3c660f7..2d0af4e 100644 --- a/docs/source/code.rst +++ b/docs/source/code.rst @@ -1,21 +1,22 @@ - +****** Models ------- +****** .. automodule:: main.models :members: - +*************** Extra Functions ---------------- +*************** .. automodule:: main.extra_func :members: +***** Views ------ +***** .. automodule:: main.views :members: diff --git a/docs/source/index.rst b/docs/source/index.rst index 2fcbe88..4cbdce9 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,13 +6,22 @@ Welcome to ZenDesk Access Controller's documentation! ===================================================== +Структура документации: +----------------------- + +Документация пользователя +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Документация разработчика +~~~~~~~~~~~~~~~~~~~~~~~~~ + .. toctree:: :maxdepth: 2 :caption: Contents: - code.rst - todo.rst + code + todo diff --git a/docs/source/todo.rst b/docs/source/todo.rst index d6ad446..64946f9 100644 --- a/docs/source/todo.rst +++ b/docs/source/todo.rst @@ -3,3 +3,4 @@ TODOs ***** .. todolist:: + diff --git a/main/extra_func.py b/main/extra_func.py index 3f679c8..f44ff2a 100644 --- a/main/extra_func.py +++ b/main/extra_func.py @@ -12,7 +12,7 @@ def set_and_get_name(user_profile: UserProfile): Функция устанавливает поле :class:`username` текущим именем в Zendesk .. TODO:: - Переделать с получением данных через API + Переделать функцию set_and_get_name с получением данных через API :param UP: Объект профиля пользователя :type UP: :class:`main.models.UserProfile` @@ -27,7 +27,7 @@ def set_and_get_email(user_profile: UserProfile): Функция устанавливает поле :class:`user.email` текущей почтой в Zendesk .. TODO:: - Переделать с получением данных через API + Переделать функцию set_and_get_email с получением данных через API :param UP: Объект профиля пользователя :type UP: :class:`main.models.UserProfile` @@ -42,7 +42,7 @@ def set_and_get_role(user_profile: UserProfile): Функция устанавливает поле :class:`role` текущей ролью в Zendesk .. TODO:: - Переделать с получением данных через API + Переделать функцию set_and_get_role с получением данных через API :param UP: Объект профиля пользователя :type UP: :class:`main.models.UserProfile` @@ -57,7 +57,7 @@ def load_and_get_image(user_profile: UserProfile): Функция загружает и устанавливает изображение в поле :class:`image` .. TODO:: - Переделать с получением изображения через API + Переделать функцию load_and_get_image с получением изображения через API :param UP: Объект профиля пользователя :type UP: :class:`main.models.UserProfile`