Improve doc strings of all functions (#269)

* initial documentation

* Fix spaces

* Examples, more documentation, remove typing from docstrnigs.

* wget version downgrade 1.20.3.20190531

* whitespaces

* Fixed defaults

* fix example in `Client`

* Client and util docstrings added

Also added some typings

* mypy and pycodestyle fixes

* Fixed examples in docstrings

* Added docstring to `common.py` file, and remove some unsed importations.

* logo documentation

* Server.py docstrings

* pycodestyle fixes

Author: lautarodapin

.github/workflows/build-and-test.yml

@@ -16,7 +16,8 @@ jobs:
 
       - name: Install choco packages
         run: |
-          choco install 7zip python wget
+          choco install 7zip python
+          choco install --allow-downgrade wget --version 1.20.3.20190531
 
       - name: Cache snap7-archive
         id: snap7-archive

doc/conf.py

@@ -29,7 +29,7 @@
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', 'sphinx.ext.napoleon']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -244,3 +244,19 @@
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
 #texinfo_show_urls = 'footnote'
+
+
+# Napoleon settings
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = True
+napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = True
+napoleon_use_admonition_for_examples = False
+napoleon_use_admonition_for_notes = False
+napoleon_use_admonition_for_references = False
+napoleon_use_ivar = False
+napoleon_use_param = True
+napoleon_use_rtype = True
+napoleon_type_aliases = None
+napoleon_attr_annotations = True