Adds Sphinx configuration files

This commit provides conf.py and makefile
to build up Plugin Guide in PDF with 'make latexpdf'
command.

It also removes width parameter to scale
the images automatically.

Change-Id: I362d5778a9fc127b6a9ede7d948e6c44a9c84e48

doc/content/guide.rst

@@ -1,23 +0,0 @@
-******************************************************
-Guide to the ScaleIO Cinder plugin ver. 1.0.0 for Fuel
-******************************************************
-
-Introduction
-============
-
-This guide provides instructions on installing, configuring and using
-ScaleIO Cinder plugin for Fuel.
-The ScaleIO plugin allows OpenStack to work with an **External** ScaleIO
-deployment. This ScaleIO plugin for Fuel extends Mirantis OpenStack
-functionality by adding support for ScaleIO block storage.
-
-ScaleIO is a software-only solution that uses existing servers local
-disks and LAN to create a virtual SAN that has all the benefits of
-external storage, but at a fraction of cost and complexity. ScaleIO
-utilizes the existing local internal storage and turns it into internal
-shared block storage.
-
-.. include:: introduction.rst
-.. include:: installation.rst
-.. include:: user-guide.rst
-.. include:: appendix.rst

doc/source/conf.py

@@ -0,0 +1,340 @@
+# -*- coding: utf-8 -*-
+#
+# fuel-plugin-scaleio-cinder documentation build configuration file, created by
+# sphinx-quickstart on Wed Oct  7 12:48:35 2015.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# 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.todo',
+#    'sphinx.ext.coverage',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'The ScaleIO Cinder plugin for Fuel'
+copyright = u'2015, EMC'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '1.0'
+# The full version, including alpha/beta/rc tags.
+release = '1.0-1.0.0-1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'fuel-plugin-scaleio-cinderdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+  ('index', 'fuel-plugin-scaleio-cinder.tex', u'The ScaleIO Cinder Plugin for Fuel Documentation',
+   u'EMC', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+# make latex stop printing blank pages between sections
+# http://stackoverflow.com/questions/5422997/sphinx-docs-remove-blank-pages-from-generated-pdfs
+latex_elements = { 'classoptions': ',openany,oneside', 'babel' : '\\usepackage[english]{babel}' }
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'fuel-plugin-scaleio-cinder', u'Guide to the ScaleIO Cinder Plugin ver. 1.0-1.0.0-1 for Fuel',
+     [u'EMC'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'fuel-plugin-scaleio-cinder', u'The ScaleIO Cinder Plugin for Fuel Documentation',
+   u'EMC', 'fuel-plugin-scaleio-cinder', 'The ScaleIO Cinder Plugin for Fuel Documentation',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+# Insert footnotes where they are defined instead of 
+# at the end.
+pdf_inline_footnotes = True
+
+
+
+# -- Options for Epub output ----------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = u'The ScaleIO Cinder Plugin for Fuel'
+epub_author = u'EMC'
+epub_publisher = u'EMC'
+epub_copyright = u'2015, EMC'
+
+# The basename for the epub file. It defaults to the project name.
+#epub_basename = u'fuel-plugin-mellanox'
+
+# The HTML theme for the epub output. Since the default themes are not optimized
+# for small screen space, using the same theme for HTML and epub output is
+# usually not wise. This defaults to 'epub', a theme designed to save visual
+# space.
+#epub_theme = 'epub'
+
+# The language of the text. It defaults to the language option
+# or en if the language is not set.
+#epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+#epub_scheme = ''
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#epub_identifier = ''
+
+# A unique identification for the text.
+#epub_uid = ''
+
+# A tuple containing the cover image and cover page html template filenames.
+#epub_cover = ()
+
+# A sequence of (type, uri, title) tuples for the guide element of content.opf.
+#epub_guide = ()
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_pre_files = []
+
+# HTML files shat should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+# The depth of the table of contents in toc.ncx.
+#epub_tocdepth = 3
+
+# Allow duplicate toc entries.
+#epub_tocdup = True
+
+# Choose between 'default' and 'includehidden'.
+#epub_tocscope = 'default'
+
+# Fix unsupported image types using the PIL.
+#epub_fix_images = False
+
+# Scale large images.
+#epub_max_image_width = 0
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#epub_show_urls = 'inline'
+
+# If false, no index is generated.
+#epub_use_index = True

doc/source/index.rst

@@ -0,0 +1,22 @@
+
+.. fuel-plugin-scaleio-cinder documentation master file, created by
+   sphinx-quickstart on Wed Oct  7 12:48:35 2015.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+============================================================
+Guide to the ScaleIO Cinder Plugin ver. 1.0-1.0.0-1 for Fuel
+============================================================
+
+User documentation
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+
+   introduction.rst
+   installation.rst
+   user-guide.rst
+   appendix.rst
+

doc/source/installation.rst

@@ -41,13 +41,12 @@ Fuel Master node, you can configure the nodes and set the parameters for the plu
 #. `Configure your environment <https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#configure-your-environment>`_.
 
 	.. image:: images/scaleio-cinder-install-2.png
-	   :width: 50%
+
 	   	   
 #. Open the **Settings tab** of the Fuel web UI and scroll down the page.
    Select the Fuel plugin checkbox to enable ScaleIO Cinder plugin for Fuel:
 
-	.. image:: images/scaleio-cinder-install-4.PNG
-	   :width: 50%
+	 .. image:: images/scaleio-cinder-install-4.PNG
 	   
    +----------------------------+----------------------------------------------------+
    |   Parameter name           |         Parameter description                      |
@@ -72,13 +71,13 @@ Fuel Master node, you can configure the nodes and set the parameters for the plu
 
     This is an example of the ScaleIO configuration parameters populated: 
 
-	.. image:: images/scaleio-cinder-install-5.PNG
-	   :width: 50%
+	  .. image:: images/scaleio-cinder-install-5.PNG
+
 	   
 #. After the configuration is done, you can add the nodes to the Openstack Deployment.
 
 	.. image:: images/scaleio-cinder-install-3.png
-	   :width: 50%
+
 	   
 #. You can run the network verification check and
    `deploy changes <https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#deploy-changes>`_ then.
@@ -86,7 +85,7 @@ Fuel Master node, you can configure the nodes and set the parameters for the plu
 #. After deployment is completed, you should see a success message:
 
 	.. image:: images/scaleio-cinder-install-complete.jpg
-	   :width: 50%
+
 	   
 .. note:: It may take an hour or more for the OpenStack deployment
           to complete, depending on your hardware configuration. 

doc/source/user-guide.rst

@@ -16,22 +16,22 @@ User Guide
     role:
 
     .. image:: images/installation/image006.png
-       :width: 50%
+
 #.  Picture of the External ScaleIO Cluster Running:
 
     .. image:: images/installation/image007.png
-       :width: 50%
+
 #.  Retrive the external ScaleIO Cluster information. For
     our example these are the configuration settings:
 
     .. image:: images/installation/image007.png
-       :width: 50%   
+ 
    
 #.  Use the ScaleIO Cluster information to update the ScaleIO Plugin
     information:
 
     .. image:: images/installation/image009.png
-       :width: 50%
+
 	   
 #.  Apply network settings
 
@@ -40,28 +40,28 @@ User Guide
     by Fuel:
 
     .. image:: images/installation/image010.png
-       :width: 50%
+
 	   
 #.  Run network verification check:
 
     .. image:: images/installation/image011.png
-       :width: 50%
+
 	   
 #.  Deploy the cluster:
 
     .. image:: images/installation/image012.png
-       :width: 50%
+
 	   
 #.  Once the deployment finished successfully, open OpenStack Dashboard (Horizon):
 
     .. image:: images/installation/image013.png
-       :width: 50%
+
 	   
 #. Check Storage tab under system information and make sure ScaleIO
     service is up and running:
 
     .. image:: images/installation/image014.png
-       :width: 50%
+
 	   
 ScaleIO Cinder plugin OpenStack operations
 ==========================================
@@ -73,7 +73,7 @@ is an example in how to attach a Volume to a running VM:
 
     .. image:: images/scaleio-cinder-install-6.PNG
        :alt: OpenStack Login
-       :width: 50%
+
 	   
 #. Review the Block storage services by navigating: Admin -> System ->
    System Information secction. You should see the ScaleIO Cinder
@@ -81,33 +81,33 @@ is an example in how to attach a Volume to a running VM:
 
     .. image:: images/scaleio-cinder-install-7.PNG
        :alt: Block Storage Services Verification
-       :width: 50%
+
 	   
 #. Review the System Volumes by navigating to: Admin -> System ->
    Volumes. You should see the ScaleIO Volume Type:
 
     .. image:: images/scaleio-cinder-install-8.PNG
        :alt: Volume Type Verification
-       :width: 50%
+
 	   
 #. Create a new OpenStack Volume:
 
     .. image:: images/scaleio-cinder-install-9.PNG
        :alt: Volume Creation
-       :width: 50%
+
 	   
 #. View the newly created Volume:
 
     .. image:: images/scaleio-cinder-install-10.PNG
        :alt: Volume Listing
-       :width: 50%
+
 	   
 #. In the ScaleIO Control Panel, you will see that no Volumes have been
    mapped yet:
 
     .. image:: images/scaleio-cinder-install-11.PNG
        :alt: ScaleIO UI No mapped Volumes
-       :width: 50%
+
 
 	  
 #. Once the Volume is attached to a VM, the ScaleIO UI will reflect the
@@ -115,7 +115,7 @@ is an example in how to attach a Volume to a running VM:
 
     .. image:: images/scaleio-cinder-install-12.png
        :alt: ScaleIO UI Mapped Volume
-       :width: 50%
+