From 2c45772ce611f12c12fca9631b1111e0452ca611 Mon Sep 17 00:00:00 2001
From: FoxMaSk <foxmaskhome@gmail.com>
Date: Thu, 26 Oct 2017 21:59:37 +0200
Subject: [PATCH] upd doc and editor settings

---
 .editorconfig               |  5 +++-
 .gitignore                  |  1 +
 .pylintrc                   |  4 +--
 README_docker.md            | 34 ----------------------
 docs/docker_guide/index.rst | 58 +++++++++++++++++++++++++++++++++++++
 docs/index.rst              |  9 ++++++
 setup.cfg                   |  2 +-
 7 files changed, 75 insertions(+), 38 deletions(-)
 delete mode 100644 README_docker.md
 create mode 100644 docs/docker_guide/index.rst

diff --git a/.editorconfig b/.editorconfig
index b19266b..f36a516 100644
--- a/.editorconfig
+++ b/.editorconfig
@@ -14,7 +14,7 @@ indent_size = 4
 
 [*.py]
 line_length=120
-known_first_party={{ cookiecutter.project_slug }}
+known_first_party=django_th
 multi_line_output=3
 default_section=THIRDPARTY
 
@@ -31,3 +31,6 @@ indent_style = tab
 [nginx.conf]
 indent_style = space
 indent_size = 2
+
+[Dockerfile]
+indent_size = 4
diff --git a/.gitignore b/.gitignore
index 1359f20..7732f76 100644
--- a/.gitignore
+++ b/.gitignore
@@ -20,3 +20,4 @@ build
 th_tox
 django_th/.env
 docs/_build
+htmlcov
diff --git a/.pylintrc b/.pylintrc
index 3a373a9..feecc1b 100644
--- a/.pylintrc
+++ b/.pylintrc
@@ -1,4 +1,4 @@
-MASTER]
+[MASTER]
 load-plugins=pylint_common, pylint_django
 
 [FORMAT]
@@ -11,4 +11,4 @@ disable=missing-docstring,invalid-name
 max-parents=13
 
 [TYPECHECK]
-generated-members=REQUEST,acl_users,aq_parent,"[a-zA-Z]+_set{1,2}",save,delete
\ No newline at end of file
+generated-members=REQUEST,acl_users,aq_parent,"[a-zA-Z]+_set{1,2}",save,delete
diff --git a/README_docker.md b/README_docker.md
deleted file mode 100644
index e1dec25..0000000
--- a/README_docker.md
+++ /dev/null
@@ -1,34 +0,0 @@
-# Docker for Trigger Happy
-
-This is very very early stage for docker support
-but this should do the trick until next time, based on https://docs.docker.com/engine/reference/commandline/build/ and https://docs.docker.com/compose/django/ and a bit of https://hub.docker.com/_/django/
-
-## Build
-
-```
-docker-compose build
-```
-
-## Run
-
-```
-docker-compose up 
-```
-
-## Database update/create
-
-```
-docker-compose run web  python manage.py migrate --settings=django_th.settings_docker
-docker-compose run web  python manage.py initial_services --settings=django_th.settings_docker
-docker-compose run web  python manage.py createsuperuser --settings=django_th.settings_docker
-```
-
-
-## Running tasks
-
-2 tasks are usually in the crontab: one to read the data source, one to publish the grabbed data:
-
-```
-docker-compose run web  python manage.py read --settings=django_th.settings_docker
-docker-compose run web  python manage.py publish --settings=django_th.settings_docker
-```
diff --git a/docs/docker_guide/index.rst b/docs/docker_guide/index.rst
new file mode 100644
index 0000000..5b0ff5d
--- /dev/null
+++ b/docs/docker_guide/index.rst
@@ -0,0 +1,58 @@
+.. _docker:
+
+Docker Guide
+============
+
+The docker file is based on `build <https://docs.docker.com/engine/reference/commandline/build/>`_ and
+`compose <https://docs.docker.com/compose/django/>`_ and a bit of `django hub <https://hub.docker.com/_/django/>`_
+
+Build
+-----
+
+The first time you use the docker image of trigger happy, launch this command to build the image.
+
+This won't be necessary for the next time
+
+.. code-block:: bash
+
+    docker-compose build
+
+
+Run
+---
+
+This is necessary each time you want to use Trigger Happy
+
+.. code-block:: bash
+
+    docker-compose up
+
+
+Database update/create
+----------------------
+
+This is necessary the first time, after building the docker image done above.
+
+.. code-block:: bash
+
+    docker-compose run web  python manage.py migrate --settings=django_th.settings_docker
+    docker-compose run web  python manage.py initial_services --settings=django_th.settings_docker
+    docker-compose run web  python manage.py createsuperuser --settings=django_th.settings_docker
+
+This is necessary only when a new release of Trigger Happy is done
+
+.. code-block:: bash
+
+    docker-compose run web  python manage.py migrate --settings=django_th.settings_docker
+
+
+Running tasks
+-------------
+
+2 tasks are usually in the crontab: one to read the data source, one to publish the grabbed data:
+
+.. code-block:: bash
+
+    docker-compose run web  python manage.py read --settings=django_th.settings_docker
+    docker-compose run web  python manage.py publish --settings=django_th.settings_docker
+
diff --git a/docs/index.rst b/docs/index.rst
index 51e6790..5030c5c 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -103,3 +103,12 @@ The Administration Guide
    :maxdepth: 2
 
    admin_guide/index
+
+
+The Docker Guide
+-----------------
+
+.. toctree::
+   :maxdepth: 2
+
+   docker_guide/index
diff --git a/setup.cfg b/setup.cfg
index 4f86822..0bc35ef 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,4 +1,4 @@
 [flake8]
-max-line-length=80
+max-line-length=120
 exclude=migrations,*settings*.py,feedsservice,.tox,build,from_*