Merge "Adding initial doc hierarchy for building with sphinx"

.gitignore

@@ -1,10 +1,49 @@
-tests/*.py[cod]
+*.py[cod]
+*.sqlite
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+.venv
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+nosetests.xml
+cover/*
+.testrepository/
+subunit.log
+AUTHORS
+ChangeLog
+
+# Translations
+*.mo
 
 # Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
 .idea
+.DS_Store
+etc/*.conf
 
-# Linux swap file
+#Linux swap file
 *.swp
 
-# Tests results
-.tox

doc/README.md

@@ -0,0 +1,6 @@
+# Sphinx DOC hints
+
+## Running sphinx:
+
+    sphinx-build -c <Path-to-conf.py> doc/source doc/build
+

doc/source/README.rst

@@ -0,0 +1 @@
+.. include:: ../../README.rst

doc/source/_templates/sidebarlinks.html

@@ -0,0 +1,11 @@
+<h3>Useful Links</h3>
+<ul>
+  <li><a href="https://launchpad.net/k8s-docker-suite-app-murano">Kubernetes & Docker apps @ Launchpad</a></li>
+  <li><a href="https://github.com/openstack/k8s-docker-suite-app-murano">Kubernetes & Docker apps @ OpenStack Github</a></li>
+</ul>
+
+{% if READTHEDOCS %}
+<script type='text/javascript'>
+    $('div.body').css('margin', 0)
+</script>
+{% endif %}

doc/source/_theme/layout.html

@@ -0,0 +1,4 @@
+{% extends "basic/layout.html" %}
+{% set css_files = css_files + ['_static/tweaks.css'] %}
+
+{% block relbar1 %}{% endblock relbar1 %}

doc/source/_theme/theme.conf

@@ -0,0 +1,4 @@
+[theme]
+inherit = nature
+stylesheet = nature.css
+pygments_style = tango

doc/source/cluster.rst

@@ -0,0 +1,2 @@
+
+.. include:: ../../Kubernetes/README.rst

doc/source/conf.py

@@ -0,0 +1,116 @@
+# -*- coding: utf-8 -*-
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+import sys
+
+
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+# 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('../../'))
+sys.path.insert(0, os.path.abspath('../'))
+sys.path.insert(0, os.path.abspath('./'))
+# -- General configuration ----------------------------------------------------
+
+# 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.autodoc'
+]
+
+if not on_rtd:
+    extensions.append('oslosphinx')
+
+wsme_protocols = ['restjson']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# autodoc generation is a bit aggressive and a nuisance when doing heavy
+# text edit cycles.
+# execute "export SPHINX_DEBUG=1" in your terminal to disable
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Kubernetes & Docker apps'
+copyright = u'2016, Murano contributors'
+
+# 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.
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+show_authors = False
+
+# 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
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# -- Options for HTML output --------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+# html_static_path = ['_static']
+
+if on_rtd:
+    html_theme_path = ['.']
+    html_theme = 'sphinx_rtd_theme'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = '%sdoc' % project
+
+# A list of ignored prefixes for module index sorting.
+# modindex_common_prefix = ['']
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+html_title = 'K8s & Docker'
+
+# Custom sidebar templates, maps document names to template names.
+html_sidebars = {
+    'index': [
+        'sidebarlinks.html', 'localtoc.html', 'searchbox.html', 'sourcelink.html'
+    ],
+    '**': [
+        'localtoc.html', 'relations.html',
+        'searchbox.html', 'sourcelink.html'
+    ]
+}
+
+# -- Options for manual page output -------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'docker', u'Kubernetes & Docker',
+     [u'OpenStack Foundation'], 1)
+]
+
+# If true, show URL addresses after external links.
+man_show_urls = True

doc/source/docker_interfaces.rst

@@ -0,0 +1 @@
+.. include:: ../../DockerInterfacesLibrary/README.rst

doc/source/index.rst

@@ -0,0 +1,21 @@
+Welcome to Kubernetes & Docker suite documentation!
+===================================================
+
+
+Overview
+--------
+
+
+User guide
+----------
+
+ * :doc:`Kubernetes Cluster guide <cluster>`
+ * :doc:`Docker Interfaces Library guide <docker_interfaces>`
+
+Developer guide
+---------------
+
+
+Indices and tables
+==================
+