linted .rst files; reviewed development guide

docs/_build/html/_sources/api.rst.txt

@@ -8,4 +8,4 @@ Information on specific functions, classes, and methods.
 .. toctree::
    :glob:
 
-   api/*
+   api/*

docs/_build/html/_sources/config.rst.txt

@@ -7,19 +7,20 @@ Applications need some kind of configuration. There are different settings
 you might want to change depending on the application environment like
 toggling the debug mode, setting credentials etc.
 
-The way hexonet.apiconnector is designed usually requires the configuration to be
-provided at runtime when connecting to the HEXONET Backend API. You can hardcode 
-the configuration in the code, which for many small scripts is for sure sufficient.
-Realtime applications and frontends need to cover some application logic around 
-using this SDK like a login form and session management.
+The way hexonet.apiconnector is designed usually requires the configuration
+to be provided at runtime when connecting to the HEXONET Backend API. You
+can hardcode the configuration in the code, which for many small scripts is
+for sure sufficient. Realtime applications and frontends need to cover some
+application logic around using this SDK like a login form and session
+management.
 
 
 Configuration Basics
 --------------------
 
 The configuration can be provided in two ways.
 Using the :meth:`hexonet.apiconnector.connect`::
-        
+
     import hexonet.apiconnector
     api = hexonet.apiconnector.connect(
         "test.user",
@@ -37,7 +38,7 @@ or by using the :class:`hexonet.apiconnector.connection.Connection` class accord
         "login": "test.user",
         "password": "test.passw0rd",
         "url": "https://coreapi.1api.net/api/call.cgi",
-        "entity": "1234",    
+        "entity": "1234",
         //"user": "hexotestman.com",//subuser view
         //"role": "testrole",//specify a role user
     });
@@ -61,20 +62,21 @@ OT&E System
 OT&E Sytem stands for Operational Test & Evaluation System.
 No costs, just for playing around with things. This system can be seen as a
 kind of sandbox system that allows to test your integration first before going
-live with it. This system and the use of our products and services is completely
-free of charge.
+live with it. This system and the use of our products and services is
+completely free of charge.
 To use this system, set configuration value for property `entity` to `1234`.
 
 LIVE System
 ^^^^^^^^^^^
 
-The real world system - This system and the use our services and products can lead
-to real costs depending on what you're exactly doing.
+The real world system - This system and the use our services and products can
+lead to real costs depending on what you're exactly doing.
 To use this system, set configuration value for property `entity` to `54cd`.
 
 Builtin Configuration Values
 ----------------------------
 
 The following configuration values are used internally by hexonet.apiconnector:
 
-Up to now - none, but this might change in future as we are continously improving our SDKs.
+Up to now - none, but this might change in future as we are continously
+improving our SDKs.

docs/_build/html/_sources/contactus.rst.txt

@@ -3,7 +3,8 @@
 Contact Us
 ==========
 
-There are several possibilities to get in touch with us, we list them in our preferred order.
+There are several possibilities to get in touch with us, we list them
+in our preferred order.
 
 - `Slack`_
 
@@ -18,6 +19,7 @@ There are several possibilities to get in touch with us, we list them in our pre
 .. _Support: https://hexonet.support
 
 Please file Bugs / Issues / Problems as `new github issue`_ to us.
-Please read our :ref:`contributing` first and use the search to check if this is already a known issue.
+Please read our :ref:`contributing` first and use the search to check
+if this is already a known issue.
 
-.. _new github issue: https://github.com/hexonet/python-sdk/issues/new
+.. _new github issue: https://github.com/hexonet/python-sdk/issues/new

docs/_build/html/_sources/contributing.rst.txt

@@ -0,0 +1,3 @@
+.. _contributing:
+
+.. mdinclude:: ../CONTRIBUTING.md

docs/_build/html/_sources/debugging.rst.txt

@@ -4,4 +4,5 @@ Debugging
 =========
 
 There's no debug feature available in hexonet.apiconnector up to now.
-This is a planned feature and will come in near future as we continously improve our SDKs.
+This is a planned feature and will come in near future as we continously
+improve our SDKs.

docs/_build/html/_sources/developmentguide.rst.txt

@@ -5,21 +5,33 @@ Development Guide
 
 Please read our :ref:`Contributing guide lines <contributing>` first.
 
+.. _requirements:
+
 Requirements
 ------------
 
 You can find any required library for this project in the *requirements.txt*:
 
 .. literalinclude:: ../requirements.txt
 
-NOTE: Make sure to have also all the extensions listed in the `docs/conf.py`_ that are required for the SDK Documentation.
+You can install them by
+
+.. code-block:: bash
+
+    pip3 install -r requirements.txt
+
+NOTE: Make sure to have also all the extensions listed in the `docs/conf.py`
+that are required for the SDK Documentation.
 
 .. _docs/conf.py: https://rawgit.com/hexonet/python-sdk/master/docs/conf.py
 
-In addition, you need nodejs/npm with globally installed module *auto-changelog* in case you want to generate an update changelog version.
+In addition, you need nodejs/npm with globally installed module
+*auto-changelog* in case you want to generate an update changelog version.
 We suggest to use nvm_.
 
-We suggest to use `Visual Studio Code`_ with installed plugins for Python Development described here_. But if you prefer any other IDE / Editor, it is fine.
+We suggest to use `Visual Studio Code`_ with installed plugins for Python
+Development described here_. But if you prefer any other IDE / Editor, it
+is fine.
 
 .. _nvm: https://github.com/creationix/nvm
 .. _Visual Studio Code: https://code.visualstudio.com
@@ -53,17 +65,21 @@ Pull Request (PR) Procedure
 * commit and push it to remote
 * open a pull request (PR)
 
-**We care then about the rest** - no need to worry about things like building current realease and versioning. 
+**We care then about the rest** - no need to worry about things like
+building current realease and versioning.
 
 **You can stop here.**
 
 The below sections are just for our reference.
-TIA for your PR and thus for your support of this project. As we have further SDKs in other languages, it might take a bit of time to check if we can role out that PR as we want to keep all our SDKs aligned.
+TIA for your PR and thus for your support of this project. As we have
+further SDKs in other languages, it might take a bit of time to check
+if we can role out that PR as we want to keep all our SDKs aligned.
 
 Versioning
 ----------
 
-We use SemVer_ for versioning. For the versions available, see the `tags on this repository`_.
+We use SemVer_ for versioning. For the versions available, see the
+`tags on this repository`_.
 
 .. _SemVer: http://semver.org/
 .. _tags on this repository: https://github.com/hexonet/python-sdk/tags
@@ -82,11 +98,14 @@ Then create a new tag version by
     git push --tags
     # push the tags to remote
 
-Create a new release out of that new tag and provide release details about the changes applied in the `git interface`_. In case of breaking changes, describe what has changed and how to migrate.
+Create a new release out of that new tag and provide release details about
+the changes applied in the `git interface`_. In case of breaking changes,
+describe what has changed and how to migrate.
 
 .. _git interface: https://github.com/hexonet/python-sdk/releases
 
-Changes will be auto-deployed by a webhook to readthedocs.org_ and automatically updated on `github pages`_.
+Changes will be auto-deployed by a webhook to readthedocs.org_ and
+automatically updated on `github pages`_.
 
 .. _readthedocs.org: https://hexonet-python-sdk.readthedocs.io
 .. _github pages: https://hexonet.github.io/python-sdk
@@ -106,7 +125,8 @@ Publish your changes to the Python Package Index (PyPi_) by
     ./scripts/uploaddistribution_live.sh
     # to upload the generated packages to the PyPi Index (pypi.org)
 
-The module can be accessed on the `PyPi (Live) Index`_ and the `PyPi (Test) Index`_.
+The module can be accessed on the `PyPi (Live) Index`_ and the
+`PyPi (Test) Index`_.
 
 .. _PyPi (Live) Index: https://pypi.org/project/hexonet.apiconnector/
 .. _PyPi (Test) Index: https://test.pypi.org/project/hexonet.apiconnector/
@@ -116,21 +136,23 @@ Generate SDK Documentation
 
 Have an eye on the generated :ref:`api`.
 
-If you want to generate it from scratch out of the sources, please use composer together with our project as follows:
+If you want to generate it from scratch out of the sources, please use
+the below script:
 
 .. code-block:: bash
-    
+
     ./scripts/generatedocs.sh
 
-The generated files are then available in subfolder "docs/_build/html". Commit and push the changes.
+The generated files are then available in subfolder "docs/_build/html".
+Commit and push the changes.
 
 Update Changelog
 ----------------
 
 After having changes merged and released, run
 
 .. code-block:: bash
-    
+
     ./scripts/changelog.sh
 
-Commit and push the changes.
+Commit and push the changes.

docs/_build/html/_sources/foreword.rst.txt

@@ -1,16 +1,18 @@
 Foreword
 ========
 
-Read this before you get started with hexonet.apiconnector. This hopefully answers some
-questions about the purpose and goals of the project.
+Read this before you get started with hexonet.apiconnector. This
+hopefully answers some questions about the purpose and goals of
+the project.
 
 HEXONET
 -------
-We're known as leading developers of domain technologies and as the worldwide experts in
-domain names. Our team is focused, and continually driven to bring customers the best
-technological solutions, TLD offerings, customer support, and domain products to make their
-internet goals a reality. Whether you have one domain or tens of thousands with us, we 
-appreciate your business.
+We're known as leading developers of domain technologies and as
+the worldwide experts in domain names. Our team is focused, and
+continually driven to bring customers the best technological
+solutions, TLD offerings, customer support, and domain products
+to make their internet goals a reality. Whether you have one
+domain or tens of thousands with us, we appreciate your business.
 
 Read more about us and our products and service on our homepage_.
 
@@ -19,10 +21,12 @@ Read more about us and our products and service on our homepage_.
 HEXONET Backend API
 -------------------
 
-HEXONET provides his products and services through a Backend System that is accessible by different options.
-One of these options is a HTTP API for which we provide SDKs in different programming languages such as
-go/golang, nodejs, php, python, java and perl.
-The hexonet.apiconnector (aka python-sdk) is one of these connector libraries that help implementors to connect
-their systems to the HEXONET Backend System.
+HEXONET provides his products and services through a Backend System
+that is accessible by different options. One of these options is a
+HTTP API for which we provide SDKs in different programming languages
+such as go/golang, nodejs, php, python, java and perl. The
+hexonet.apiconnector (aka python-sdk) is one of these connector
+libraries that help implementors to connect their systems to the
+HEXONET Backend System.
 
 Continue to :ref:`installation` or the :ref:`quickstart`.

docs/_build/html/_sources/index.rst.txt

@@ -7,13 +7,14 @@ Welcome to hexonet.apiconnector
     :alt: hexonet.apiconnector: Connector library for the HEXONET Backend API
     :align: right
 
-Welcome to hexonet.apiconnector's documentation. Get started with :ref:`installation`
-and then get an overview with the :ref:`quickstart`. There is also a Demo App available for 
-any of our SDK libraries. The one for hexonet.apiconnector (python-sdk) is available at github_.
+Welcome to hexonet.apiconnector's documentation. Get started with
+:ref:`installation` and then get an overview with the :ref:`quickstart`.
+There is also a Demo App available for  any of our SDK libraries. The
+one for hexonet.apiconnector (python-sdk) is available at github_.
 
 .. _github: https://github.com/hexonet/python-sdk-demo
 
-The rest of the docs describe each component of hexonet.apiconnector in detail, with a full
-reference in the :ref:`api` section.
+The rest of the docs describe each component of hexonet.apiconnector in
+detail, with a full reference in the :ref:`api` section.
 
-.. include:: contents.rst.inc
+.. include:: contents.rst.inc

docs/_build/html/_sources/installation.rst.txt

@@ -6,20 +6,25 @@ Installation
 Python Version
 --------------
 
-We recommend using the latest version of Python 3. hexonet.apiconnector supports Python 3.x and 2.7.
+We recommend using the latest version of Python 3. hexonet.apiconnector
+supports Python 3.x and 2.7.
 
 
 Dependencies
 ------------
 
-There are NO dependencies to install. If this changes, we will list them here and they will be installed
-automatically when hexonet.apiconnector is getting installed.
+There are NO dependencies to install. If this changes, we will list them
+here and they will be installed automatically when hexonet.apiconnector
+is getting installed.
 
+There are :ref:`dependencies<requirements>` that we just need in steps of
+our build process.
 
 Installation
 -------------
 
-Within the your environment, use the following command to install hexonet.apiconnector:
+Within the your environment, use the following command to install
+hexonet.apiconnector:
 
 .. code-block:: sh
 
@@ -29,5 +34,6 @@ Within the your environment, use the following command to install hexonet.apicon
     pip3 install hexonet.apiconnector
     # for python 3.x
 
-The connector library is now installed. Check out the :doc:`/quickstart` or go to the
-:doc:`Documentation Overview </index>`.
+The connector library is now installed. Check out the
+:doc:`/quickstart` or go to the
+:doc:`Documentation Overview </index>`.

docs/_build/html/_sources/license.rst.txt

@@ -1,7 +1,7 @@
 License
 =======
 
-hexonet.apiconnector is licensed under MIT License. 
+hexonet.apiconnector is licensed under MIT License.
 A short, permissive software license. Basically, you can do whatever you
 want as long as you include the original copyright and license notice in
 any copy of the software/source.
@@ -25,8 +25,8 @@ documentation.
     :ref:`authors` section.
 
 -   The ":ref:`mit-license`" applies to all the source code shipped as
-    part of hexonet.apiconnector (the module itself as well as the examples and the unittests)
-    as well as documentation.
+    part of hexonet.apiconnector (the module itself as well as the examples and
+    the unittests) as well as documentation.
 
 .. _mit-license: