Documentation Updates

.gitignore

@@ -11,3 +11,6 @@
 *.a
 examples/hello_world/simple_app
 examples/zmq_shell/app
+docs/_build/
+docs/_static/
+docs/_templates/

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = AOSharedServiceLibrary
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,157 @@
+# -*- coding: utf-8 -*-
+#
+# AO Shared Service Library documentation build configuration file, created by
+# sphinx-quickstart on Sat Jun 24 01:55:38 2017.
+#
+# 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.
+
+# 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.
+#
+import os, subprocess
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+# Run Doxygen
+subprocess.call('cd .. ; doxygen', shell=True)
+html_extra_path = ['html/html']
+
+
+# -- 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 = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'AO Shared Service Library'
+copyright = u'2017, AO'
+author = u'AO'
+
+# 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 = u'1.0'
+# The full version, including alpha/beta/rc tags.
+release = u'1.0.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = 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 = 'alabaster'
+
+# 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 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']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'AOSharedServiceLibrarydoc'
+
+
+# -- 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': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# 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 = [
+    (master_doc, 'AOSharedServiceLibrary.tex', u'AO Shared Service Library Documentation',
+     u'AO', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'aosharedservicelibrary', u'AO Shared Service Library Documentation',
+     [author], 1)
+]
+
+
+# -- 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 = [
+    (master_doc, 'AOSharedServiceLibrary', u'AO Shared Service Library Documentation',
+     author, 'AOSharedServiceLibrary', 'One line description of project.',
+     'Miscellaneous'),
+]

docs/html/html/classZmqIn__coll__graph.map

@@ -0,0 +1,3 @@
+<map id="ZmqIn" name="ZmqIn">
+<area shape="rect" id="node2" href="$classZmqio.html" title="An Interface for ZMQIO. " alt="" coords="5,5,64,32"/>
+</map>

docs/html/html/classZmqIn__inherit__graph.map

@@ -0,0 +1,3 @@
+<map id="ZmqIn" name="ZmqIn">
+<area shape="rect" id="node2" href="$classZmqio.html" title="An Interface for ZMQIO. " alt="" coords="5,5,64,32"/>
+</map>

docs/html/html/classZmqOut__coll__graph.map

@@ -0,0 +1,3 @@
+<map id="ZmqOut" name="ZmqOut">
+<area shape="rect" id="node2" href="$classZmqio.html" title="An Interface for ZMQIO. " alt="" coords="11,5,69,32"/>
+</map>

docs/html/html/classZmqOut__inherit__graph.map

@@ -0,0 +1,3 @@
+<map id="ZmqOut" name="ZmqOut">
+<area shape="rect" id="node2" href="$classZmqio.html" title="An Interface for ZMQIO. " alt="" coords="11,5,69,32"/>
+</map>

docs/html/html/classZmqio__inherit__graph.map

@@ -0,0 +1,4 @@
+<map id="Zmqio" name="Zmqio">
+<area shape="rect" id="node2" href="$classZmqIn.html" title="An Inbound ZMQ Manager. " alt="" coords="5,80,64,107"/>
+<area shape="rect" id="node3" href="$classZmqOut.html" title="An Outbound ZMQ Manager. " alt="" coords="88,80,157,107"/>
+</map>

docs/html/html/inherit_graph_0.map

@@ -0,0 +1,3 @@
+<map id="Graphical Class Hierarchy" name="Graphical Class Hierarchy">
+<area shape="rect" id="node1" href="$classCommandLineInterface.html" title="CommandLineInterface. " alt="" coords="5,5,163,32"/>
+</map>

docs/html/html/inherit_graph_1.map

@@ -0,0 +1,3 @@
+<map id="Graphical Class Hierarchy" name="Graphical Class Hierarchy">
+<area shape="rect" id="node1" href="$classCommandLineInterpreterFactory.html" title="The Command Line Interpreter Service Component Factory. " alt="" coords="5,5,215,32"/>
+</map>