From 3155374185b37a75e4ab172a1969b738ffb2140e 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?= Date: Wed, 28 Apr 2021 21:17:41 +0300 Subject: [PATCH] Spell new docs --- README.md | 15 +++--- docs/source/conf.py | 17 +++---- docs/source/spelling_wordlist.txt | 84 +++++++++++++++++++++++++++++++ main/views.py | 2 +- 4 files changed, 101 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 154ca60..8838171 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -# ZenDesk Access Controller - ## Управление правами доступа Идея - написать программу(Web приложение), которая будет выдавать права пользователям системы по запросу самого @@ -39,7 +37,7 @@ ## Quickstart -Перед запуском требуется неообходимо `.env` файл. +Перед запуском необходимо создать `.env` файл. ```bash cp .env.example .env ``` @@ -71,7 +69,7 @@ pip install -r requirements/dev.txt ``` ACTRL_DEBUG={0/1} - включить режим дебага ACTRL_HOST={HOSTNAME} - при запуске без дебага, надо указать домен на котором будет работать приложение -ACTRL_SECRET_KEY={DJANGO_SECRET_KEY} - секретный ключ сгенерированый Django +ACTRL_SECRET_KEY={DJANGO_SECRET_KEY} - секретный ключ сгенерированный Django ACTRL_EMAIL_HOST={SMTP_HOST} - домен почтового сервера через который приложение будет отправлять письма, например "smtp.gmail.com" ACTRL_EMAIL_PORT={SMTP_PORT} - порт для почтового сервера, например 587, 465 , 2525 @@ -133,7 +131,7 @@ docker run -d -p 8000:8000 \ -v {ABSOLUTE_PATH_TO_DB}:/zendesk-access-controller/db \ access_controller:latest ``` -- открываем запущеный контейнер в браузере (можно перейти по ссылке http://localhost:8000/) +- открываем запущенный контейнер в браузере (можно перейти по ссылке http://localhost:8000/) ## Запуск с тестовыми юзерами: @@ -144,7 +142,7 @@ docker run -d -p 8000:8000 \ - Пользователь - `123@test.ru` / `zendeskuser` Не сработает если домен песочницы отличается от `ngenix1612197338` (на другом домене нужно будет создать сначала пользователей в песочнице с правами админа и легкого агента -с этими же почтами, назначить им организацию `SYSTEM`) +с этими же email, назначить им организацию `SYSTEM`) ## Параметры тестовой песочницы: @@ -156,6 +154,11 @@ pylint ../access_controller ## Для приведения файлов к стандарту PEP8 используем: autopep8 --in-place +##Для проверки орфографии: +cd docs +(set -a && source ../.env && make spelling) + + ## Read more - Zenpy: [http://docs.facetoe.com.au](http://docs.facetoe.com.au) - Zendesk API: [https://developer.zendesk.com/rest_api/docs/](https://developer.zendesk.com/rest_api/docs/) diff --git a/docs/source/conf.py b/docs/source/conf.py index 2bd665b..1495347 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -14,12 +14,11 @@ import os import sys import inspect import enchant -import m2r +import django sys.path.insert(0, os.path.abspath('../../')) -import django os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'access_controller.settings') os.environ.setdefault('DJANGO_CONFIGURATION', 'Dev') @@ -117,13 +116,12 @@ def skip_queryset(app, what, name, obj, skip, options): def fix_sig(app, what, name, obj, options, signature, return_annotation): return ("", "") -def setup(app): - # Register the docstring processor with sphinx - app.connect('autodoc-process-docstring', process_django_models) - app.connect('autodoc-skip-member', skip_queryset) - app.connect('autodoc-process-docstring', process_modules) - app.connect("autodoc-process-signature", fix_sig) - +# def setup(app): +# # Register the docstring processor with sphinx +# app.connect('autodoc-process-docstring', process_django_models) +# app.connect('autodoc-skip-member', skip_queryset) +# app.connect('autodoc-process-docstring', process_modules) +# app.connect("autodoc-process-signature", fix_sig) # Add any Sphinx extension module names here, as strings. They can be @@ -139,7 +137,6 @@ extensions = { 'sphinx.ext.inheritance_diagram', 'sphinx_autodoc_typehints', 'sphinxcontrib.spelling', - # 'm2r' } diff --git a/docs/source/spelling_wordlist.txt b/docs/source/spelling_wordlist.txt index 4ccad53..ad71758 100644 --- a/docs/source/spelling_wordlist.txt +++ b/docs/source/spelling_wordlist.txt @@ -83,7 +83,9 @@ functions Serializer Serializers Сериализатор +Сериализаторы сериализатор +сериализатора переадресации чекбоксов админских @@ -105,4 +107,86 @@ db Read Zenpy залогинен +т +д +rolchangelogs +извеcтно +role +View +Model +type +param +rtype +return +UsersViewSet +list +engineers +agents +request +rest +framework +response +Сэндбокс +админскими +логирование +code +block +d +p +ACTRL_DEBUG +дебага +ACTRL_HOST +HOSTNAME +ACTRL_SECRET_KEY +DJANGO_SECRET_KEY +ACTRL_EMAIL_HOST +SMTP_HOST +smtp.gmail.com +ACTRL_EMAIL_PORT +SMTP_PORT +ACTRL_EMAIL_TLS +USE_TLS +TLS +ACTRL_EMAIL_HOST_USER +USERNAME +ACTRL_EMAIL_HOST_PASSWORD +PASSWORD +ACTRL_FROM_EMAIL +EMAIL +ACTRL_SERVER_EMAIL +ACTRL_API_EMAIL +ACTRL_API_PASSWORD +ACTRL_API_TOKEN +API_TOKEN +ACTRL_ZENDESK_SUBDOMAIN +DOMAIN +ENG_CROLE_ID +ENGINEER_CUSTOM_ROLE_ID +custom_role_id +LA_CROLE_ID +LIGHT_AGENT_CUSTOM_ROLE_ID +EMPL_GROUP +EMPLOYEE_GROUP_NAME +ССКС +BUF_GROUP +BUFFER_GROUP_NAME +буферной +тикетами +ST_EMAIL +SOLVED_TICKETS_EMAIL +LICENSE_NO +LICENSE_NO +SHIFTH +SHIFT_HOURS +ABSOLUTE +ABSOLUTE_PATH_TO_DB +PATH +TO +DB +latest +in +place +cd +docs +a diff --git a/main/views.py b/main/views.py index 15f393e..38e7f73 100644 --- a/main/views.py +++ b/main/views.py @@ -347,7 +347,7 @@ class UsersViewSet(viewsets.ReadOnlyModelViewSet): :param queryset: Список пользователей с ролью 'agent' :type queryset: :class:`str` :param serializer_class: Класс сериализатор для модели профиля пользователя - :type serializer_class :class:`ProfileSerializer` + :type serializer_class: :class:`ProfileSerializer` """ queryset = UserProfile.objects.filter(role='agent') serializer_class = ProfileSerializer