diff --git a/.gitignore b/.gitignore index 889a60c..5cdf992 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,7 @@ # Created by https://www.toptal.com/developers/gitignore/api/django,pycharm+all,python,linux,macos,windows # Edit at https://www.toptal.com/developers/gitignore?templates=django,pycharm+all,python,linux,macos,windows +README.rst ### Django ### *.log diff --git a/.pylintrc b/.pylintrc index 0f1221a..d0114f8 100644 --- a/.pylintrc +++ b/.pylintrc @@ -37,7 +37,7 @@ limit-inference-results=100 # List of plugins (as comma separated values of python module names) to load, # usually to register additional checkers. load-plugins=pylint_django -django-settings-module=access_controller_new.access_controller.settings +django-settings-module=access_controller.settings # Pickle collected data for later comparisons. persistent=yes diff --git a/README.md b/README.md index c7310d0..7e2c62b 100644 --- a/README.md +++ b/README.md @@ -178,22 +178,24 @@ docker run -d -p 8000:8000 \ Пример полной конфигурации можно найти в [.env.example](.env.example). Почту и токен админа ZenDesk взять у руководителя (если вы не админ). ## Для проверки pylint используем: -pylint --django-settings-module=access_controller.access_controller.settings ../access_controller (каталог, где лежит проект) +```bash +pylint main +``` ## Для приведения файлов к стандарту PEP8 используем: +```bash autopep8 --in-place filename +``` ##Для проверки орфографии: +```bash cd docs - make spelling +``` ##Для обновления документации: -m2r README.md - -cd docs - -make html - +```bash +./documentation.sh +``` ## Read more - Zenpy: [http://docs.facetoe.com.au](http://docs.facetoe.com.au) diff --git a/documentation.sh b/documentation.sh new file mode 100755 index 0000000..bfb2cd0 --- /dev/null +++ b/documentation.sh @@ -0,0 +1,7 @@ +#!/usr/bin/env bash + +m2r README.md +cd docs +make html +cd .. +rm README.rst