Merge pull request #11 from vroncevic/dev

sync

.github/workflows/gen_coap_service_docker_checker.yml

@@ -2,8 +2,12 @@ name: gen_coap_service docker checker
 on:
   push:
     branches: [ master ]
+    paths:
+      - 'Dockerfile'
   pull_request:
     branches: [ master ]
+    paths:
+      - 'Dockerfile'
 jobs:
   build:
     runs-on: ubuntu-latest

.github/workflows/gen_coap_service_package.yml

@@ -2,14 +2,26 @@ name: Python package gen_coap_service
 on:
   push:
     branches: [ master ]
+    paths:
+      - 'gen_coap_service/**'
+      - 'MANIFEST.in'
+      - 'pyproject.toml'
+      - 'setup.cfg'
+      - 'setup.py'
   pull_request:
     branches: [ master ]
+    paths:
+      - 'gen_coap_service/**'
+      - 'MANIFEST.in'
+      - 'pyproject.toml'
+      - 'setup.cfg'
+      - 'setup.py'
 jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [2.7, 3.5, 3.6, 3.7, 3.8]
+        python-version: [2.7, 3.6, 3.7, 3.8]
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python ${{ matrix.python-version }}
@@ -22,4 +34,4 @@ jobs:
         # stop the build if there are Python syntax errors or undefined names
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide ===> strict 79
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=79 --statistics
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=79 --statistics

.github/workflows/gen_coap_service_py_checker.yml

@@ -2,8 +2,14 @@ name: gen_coap_service py checker
 on:
   push:
     branches: [ master ]
+    paths:
+      - 'gen_coap_service/**'
+      - 'setup.py'
   pull_request:
     branches: [ master ]
+    paths:
+      - 'gen_coap_service/**'
+      - 'setup.py'
 jobs:
   build:
     runs-on: ubuntu-latest

.github/workflows/gen_coap_service_python2_publish.yml

@@ -2,8 +2,20 @@ name: Install Python2 Package gen_coap_service
 on:
   push:
     branches: [ master ]
+    paths:
+      - 'gen_coap_service/**'
+      - 'MANIFEST.in'
+      - 'pyproject.toml'
+      - 'setup.cfg'
+      - 'setup.py'
   pull_request:
     branches: [ master ]
+    paths:
+      - 'gen_coap_service/**'
+      - 'MANIFEST.in'
+      - 'pyproject.toml'
+      - 'setup.cfg'
+      - 'setup.py'
 jobs:
   deploy:
     runs-on: ubuntu-latest

.github/workflows/gen_coap_service_python3_publish.yml

@@ -2,8 +2,20 @@ name: Install Python3 Package gen_coap_service
 on:
   push:
     branches: [ master ]
+    paths:
+      - 'gen_coap_service/**'
+      - 'MANIFEST.in'
+      - 'pyproject.toml'
+      - 'setup.cfg'
+      - 'setup.py'
   pull_request:
     branches: [ master ]
+    paths:
+      - 'gen_coap_service/**'
+      - 'MANIFEST.in'
+      - 'pyproject.toml'
+      - 'setup.cfg'
+      - 'setup.py'
 jobs:
   deploy:
     runs-on: ubuntu-latest

.github/workflows/gen_coap_service_toc.yml

@@ -1,5 +1,8 @@
 name: TOC Generator gen_coap_service
-on: push
+on:
+  push:
+    paths:
+      - '**.md'
 jobs:
   generateTOC:
     name: TOC Generator

README.md

@@ -30,6 +30,10 @@ other information that should be provided before the modules are installed.
 
 ### Installation
 
+Used next development environment
+
+![Development environment](https://raw.githubusercontent.com/vroncevic/gen_coap_service/dev/docs/debtux.png)
+
 ![Install Python2 Package](https://github.com/vroncevic/gen_coap_service/workflows/Install%20Python2%20Package%20gen_coap_service/badge.svg?branch=master) ![Install Python3 Package](https://github.com/vroncevic/gen_coap_service/workflows/Install%20Python3%20Package%20gen_coap_service/badge.svg?branch=master)
 
 Currently there are three ways to install tool:
@@ -85,11 +89,11 @@ You can use docker to create image/container.
 
 Base flow of generation process:
 
-![alt tag](https://raw.githubusercontent.com/vroncevic/gen_coap_service/dev/docs/gen_coap_service_flow.png)
+![CoAP generation flow](https://raw.githubusercontent.com/vroncevic/gen_coap_service/dev/docs/gen_coap_service_flow.png)
 
 ### Tool structure
 
-**gen_coap_service** is based on OOP:
+**gen_coap_service** is based on OOP.
 
 Generator structure:
 
@@ -103,6 +107,7 @@ Generator structure:
 
 More documentation and info at:
 * [gen_coap_service.readthedocs.io](https://gen_coap_service.readthedocs.io/en/latest/)
+* [CoAP Service](overview.md)
 * [www.python.org](https://www.python.org/)
 
 ### Copyright and Licence

docs/Makefile

@@ -0,0 +1,12 @@
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,33 @@
+@ECHO OFF
+
+pushd %~dp0
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../../'))
+project = u'gen_coap_service'
+copyright = u'2020, Vladimir Roncevic <elektron.ronca@gmail.com>'
+author = u'Vladimir Roncevic <elektron.ronca@gmail.com>'
+version = u'1.0.0'
+release = u'https://github.com/vroncevic/gen_coap_service/releases/'
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
+templates_path = ['_templates']
+source_suffix = '.rst'
+master_doc = 'index'
+language = None
+exclude_patterns = []
+pygments_style = None
+html_theme = 'alabaster'
+html_static_path = ['_static']
+htmlhelp_basename = 'gen_coap_servicedoc'
+latex_elements = {}
+latex_documents = [(
+    master_doc, 'gen_coap_service.tex', u'gen\\_coap\\_service Documentation',
+    u'Vladimir Roncevic \\textless{}elektron.ronca@gmail.com\\textgreater{}',
+    'manual'
+)]
+man_pages = [(
+    master_doc, 'gen_coap_service', u'gen_coap_service Documentation',
+    [author], 1
+)]
+texinfo_documents = [(
+    master_doc, 'gen_coap_service', u'gen_coap_service Documentation',
+    author, 'gen_coap_service', 'One line description of project.',
+    'Miscellaneous'
+)]
+epub_title = project
+epub_exclude_files = ['search.html']

docs/source/index.rst

@@ -0,0 +1,20 @@
+.. gen_coap_service documentation master file, created by
+   sphinx-quickstart on Wed Aug 18 19:16:37 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to gen_coap_service's documentation!
+============================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`