Corrected documentation

Author: ygorelik

Dockerfile

@@ -8,7 +8,7 @@ RUN echo 'Installing dependencies  and ydk-py'
 
 WORKDIR /root/ydk-py
 
-RUN /bin/bash -c './dependencies_xenial.sh && ./dependencies_gnmi.sh && tests.sh'
+RUN /bin/bash -c './dependencies_xenial.sh && ./dependencies_gnmi.sh && ./tests.sh'
 
 RUN pip3 install ./core/dist/ydk-0.8.2.tar.gz
 RUN python3 -c "import ydk.providers"

README.rst

@@ -1,5 +1,5 @@
-.. image::  https://travis-ci.org/CiscoDevNet/ydk-py.svg?branch=master
-    :target: https://travis-ci.org/CiscoDevNet/ydk-py
+.. image::  https://travis-ci.com/CiscoDevNet/ydk-py.svg?branch=master
+    :target: https://travis-ci.com/CiscoDevNet/ydk-py
 
 .. image:: https://img.shields.io/docker/automated/jrottenberg/ffmpeg.svg
     :alt: Docker Automated build
@@ -12,20 +12,20 @@ YANG Development Kit (Python)
 .. contents:: Table of Contents
 
 Overview
---------
+========
 
 The YANG Development Kit (YDK) is a Software Development Kit that provides API's that are modeled in YANG. 
 The main goal of YDK is to reduce the learning curve of YANG data models by expressing the model semantics in an API and abstracting protocol/encoding details.  
 YDK is composed of a core package that defines services and providers, plus one or more module bundles that are based on YANG models.
 
 Backward Compatibility
-----------------------
+======================
 
 The Python YDK-0.8.2 core package is compatible with all model bundles generated previously with ydk-gen releases starting from 0.7.3.
 Please see `the release notes <https://github.com/CiscoDevNet/ydk-py/releases/tag/0.8.2>`_ for details. 
 
 Docker
-------
+======
 
 A `docker image <https://docs.docker.com/engine/reference/run/>`_ is automatically built with the latest ydk-py installed. 
 This be used to run ydk-py without installing anything natively on your machine.
@@ -37,10 +37,10 @@ See the `docker documentation <https://docs.docker.com/engine/reference/run/>`_
 
 
 System Requirements
--------------------
+===================
 
 Linux
-~~~~~
+-----
 
 **Ubuntu (Debian-based)**
 
@@ -86,7 +86,7 @@ The following packages must be present in your system before installing YDK-Py.
   sudo yum install https://devhub.cisco.com/artifactory/rpm-ydk/0.8.2/libydk-0.8.2-1.x86_64.rpm
 
 MacOS
-~~~~~
+-----
 
 It is required to install Xcode command line tools, `homebrew <http://brew.sh>`_ and the following homebrew packages on your system before installing YDK-Py::
 
@@ -174,15 +174,15 @@ Python Requirements
 
 YDK supports both Python2 and Python3 versions.  At least Python2.7 or Python3.4 must be installed on your system. 
 
-It is also required for Python installation to include corresponding shared library. As example: 
+It is also required for Python installation to include corresponding shared library. As example::
 
- - python2.7  - /usr/lib/x86_64-linux-gnu/libpython2.7.so
- - python3.5m - /usr/lib/x86_64-linux-gnu/libpython3.5m.so
+  python2.7  - /usr/lib/x86_64-linux-gnu/libpython2.7.so
+  python3.5m - /usr/lib/x86_64-linux-gnu/libpython3.5m.so
  
 Please follow `System Requirements` to assure presence of shared Python libraries.
 
 Mac OS
-======
+~~~~~~
 
 The developers of Python2 on Mac OS might face an issue ([#837](https://github.com/CiscoDevNet/ydk-gen/issues/837)).
 This is well known and documented issue. Each developer might have different approaches for its resolution.
@@ -191,42 +191,49 @@ One of them is to use Python2 virtual environment. See section below for details
 In addition it is required properly set CMAKE_LIBRARY_PATH environment variable to assure that `cmake` uses correct Python library.
 Follow these steps to find and set correct library path.
 
-1. Find installations of `libpython2.7` library::
+1. Find installations of `libpython2.7` library:
 
-  locate libpython2.7.dylib
-
-Example::
+.. code-block:: sh
 
+  # Example:
   $ locate libpython2.7.dylib
   /System/Library/Frameworks/Python.framework/Versions/2.7/lib/libpython2.7.dylib
   /System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/config/libpython2.7.dylib
   /usr/lib/libpython2.7.dylib
   /usr/local/Cellar/python@2/2.7.15_1/Frameworks/Python.framework/Versions/2.7/lib/libpython2.7.dylib
   /usr/local/Cellar/python@2/2.7.15_1/Frameworks/Python.framework/Versions/2.7/lib/python2.7/config/libpython2.7.dylib
 
-2. Choose non-system Python library installation and set CMAKE_LIBRARY_PATH before any YDK component installation. Example::
+2. Choose non-system Python library installation and set CMAKE_LIBRARY_PATH before any YDK component installation. Example:
+
+.. code-block:: sh
 
   export CMAKE_LIBRARY_PATH=/usr/local/Cellar/python@2/2.7.15_1/Frameworks/Python.framework/Versions/2.7/lib
 
-3. Run YDK core package installation with '-v' flag to check that `PythonLibs` points to correct library path. Example::
+3. Run YDK core package installation with '-v' flag to check that `PythonLibs` points to correct library path. Example:
+
+.. code-block:: sh
 
   $ ./generate.py --core
   $ pip install -v gen-api/python/ydk/dist/ydk*.tar.gz
   
-  # In 'cmake' log look for 'PythonLibs' and 'found version' settings line:
+4. In 'cmake' log look for 'PythonLibs' and 'found version' settings line:
 
+.. code-block:: sh
+
   -- Found PythonLibs: /usr/local/Cellar/python@2/2.7.15_1/Frameworks/Python.framework/Versions/2.7/lib/libpython2.7.dylib (found version "2.7.15")
 
-4. Finally test you YDK core library installation from CLI, making sure there are no errors::
+5. Finally test you YDK core library installation from CLI, making sure there are no errors:
+
+.. code-block:: sh
 
   $ python -c "import ydk.types"
 
 
 How to install
---------------
+==============
 
 Using Python virtual environment
-================================
+--------------------------------
 
 You may want to perform the installation under Python virtual environment (`virtualenv <https://pypi.python.org/pypi/virtualenv/>`_/`virtualenvwrapper  <https://pypi.python.org/pypi/virtualenvwrapper>`_).  
 The virtual environment allows you to install multiple versions of YDK if needed.  In addition, it prevents any potential conflicts between package dependencies in your system.
@@ -252,7 +259,7 @@ Once Python virtual environment is activated, you can perform quick installation
 Take into consideration that you must not attempt to install YDK as root user under virtual environment.
 
 Quick Install
-~~~~~~~~~~~~~
+-------------
 
 You can install the latest model packages from the Python package index.  Note that, in some systems, you need to install the new package as root.  
 You get a fully operational YDK environment by installing the ``cisco-ios-xr`` and/or ``cisco-ios-xe`` bundle(s) (depending on whether you're developing for an IOS XR or IOS XE platform), 
@@ -296,7 +303,7 @@ To installation of model bundles on CentOS/RedHat platforms require special hand
   pip install --install-option="--install-purelib=/usr/lib64/python3.6/site-packages" --no-deps ydk-models-cisco-ios-xe
 
 Installing from Source
-~~~~~~~~~~~~~~~~~~~~~~
+----------------------
 
 If you prefer not to use the YDK packages in the Python package index, you need to install manually the ``ydk`` core package and then the model bundles you plan to use.  
 To install the ``ydk`` core package, execute::
@@ -326,14 +333,15 @@ To install the ``cisco-ios-xr`` bundle, execute::
   cisco-ios-xr$ cd ..
 
 Documentation and Support
---------------------------
+=========================
+
 - Read the `API documentation <http://ydk.cisco.com/py/docs>`_ for details on how to use the API and specific models
 - Samples can be found under the `samples directory <https://github.com/CiscoDevNet/ydk-py/tree/master/core/samples>`_
 - Hundreds of additional samples can be found in the `YDK-PY samples repository <https://github.com/CiscoDevNet/ydk-py-samples>`_
 - Join the `YDK community <https://communities.cisco.com/community/developer/ydk>`_ to connect with other users and with the makers of YDK
 - Additional YDK information can be found at `ydk.io <http://ydk.io>`_
 
 Release Notes
---------------
+=============
 
 The current YDK release version is 0.8.2. YDK-Py is licensed under the Apache 2.0 License.