Updated sphinx config and documentation

Author: naim94a

.gitignore

@@ -1,3 +1,4 @@
 docs/_build/
 env/
 *.pyc
+dist/

docs/conf.py

@@ -19,6 +19,7 @@
 #
 import os
 import sys
+import alabaster
 sys.path.insert(0, os.path.abspath('..'))
 from vix import __version__
 
@@ -32,6 +33,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    'alabaster',
     'sphinx.ext.autodoc',
 ]
 
@@ -53,7 +55,7 @@
 
 # General information about the project.
 project = 'vix'
-copyright = '2016, Naim A.'
+copyright = '2017, Naim A.'
 author = 'Naim A.'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -142,10 +144,14 @@
     'github_repo': 'vix',
     'description': 'The unofficial python binding for VIX',
     'analytics_id': 'UA-11289087-19',
+    'sidebar_collapse': False,
+    'show_related': True,
+    'fixed_sidebar': True,
 }
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []
+html_theme_path = [alabaster.get_path()]
 
 # The name for this set of Sphinx documents.
 # "<project> v<release> documentation" by default.
@@ -191,7 +197,15 @@
 
 # Custom sidebar templates, maps document names to template names.
 #
-# html_sidebars = {}
+html_sidebars = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',
+        'searchbox.html',
+        'donate.html',
+    ]
+}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.

docs/index.rst

@@ -3,15 +3,37 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-VIX python binding
+.. toctree::
+    :maxdepth: 2
+    :hidden:
+
+    tutorials
+    vix
+
+VIX Python binding
 ==================
 
 This is an unofficial binding of VMware's VIX API.
 
 The VIX project is hosted on GitHub: https://github.com/naim94a/vix.
 Feel free to submit pull requests and issues.
 
-Example:
+About
+-----
+VIX is a C library created by VMWare, the aim of this project is to wrap it in python.
+This project allow Object-Oriented access to various VMWare products.
+
+
+Installing
+----------
+
+.. code-block:: shell
+
+	pip install vix
+
+
+Example usage
+-------------
 
 .. code-block:: python
 	:caption: snapshot-demo.py
@@ -34,19 +56,3 @@ Example:
 
 	except VixError as ex:
 		print("Operatation failed: {0}".format(ex))
-
-API:
-
-.. toctree::
-   :maxdepth: 4
-
-   vix
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-

docs/tutorials.rst

@@ -0,0 +1,49 @@
+Tutorials
+=========
+
+Capturing screens
+-----------------
+Every wanted to take a screenshot of whats going on in a running VM?
+Well, you are in luck! VIX supports taking screenshots, this will require you to know a guest's username/password.
+
+The VIX python binding can return a screenshot in PNG format. You can choose between having the file written to a file, or getting the PNG buffer.
+
+This example will demonstrate how to take screenshots from a VM every 10 seconds.
+
+.. code-block:: python
+	:caption: screenshots.py
+
+	import time
+	from vix import VixHost
+
+	host = VixHost()
+	vm = host.open_vm('~/my vm.vmx')
+
+	# Must login to do some things...
+	vm.login('root', 'toor')
+	while True:
+		vm.capture_screen_image('~/IMG_{name}_{timestamp:.0f}.png'.format(name=vm.name, timestamp=time.time()))
+		time.sleep(10.0)
+
+
+Cloning Machines
+----------------
+Cloning machines are usually a more useful action then capturing screenshots. It is a pretty simple task to...
+
+.. code-block:: python
+	:caption: snapshot.py
+
+	from vix import VixHost
+
+	host = VixHost()
+	vm = host.open_vm('~/template.vmx')
+
+	# Assuming that template.vmx is currently on a powered off snapshot.
+	snapshot = vm.snapshot_get_current()
+
+	# This clone will be based of 'template.vmx' at the specified snapshot.
+	# Linked snapshots take less space...
+	cloned = vm.clone('~/cloned.vmx', snapshot=snapshot, linked=True)
+
+	# Let fire up our cloned machine!
+	cloned.power_on()

docs/vix.rst

@@ -1,5 +1,5 @@
-vix package
-===========
+VIX Reference
+=============
 
 VixHost class
 -------------