Move documentation to new sphinx build

TODO: Reorganize documentation into properly named subfolders
TODO: Add logos to documentation (see index.rst for example)
Note you can see the results of this change via a link in the gerrit
comments below
NOTE: The merge job for your project has not been enabled, this code
will not go to the artifacts page upon a merge. you can merge it and
work on it in your own time, please contact me to enable the merge
(the merge job will make this documentation avaliable to the public on
artifacts.opnfv.org)
JIRA:RELENG-15

Change-Id: I8fd519393416e2ac2b3ada6fe0670aa4d038fc87
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>

diff --git a/docs/etc/conf.py b/docs/etc/conf.py
new file mode 100644 (file)
index 0000000..0066035
--- /dev/null
+++ b/docs/etc/conf.py
@@ -0,0 +1,34 @@
+import datetime
+import sys
+import os
+
+try:
+    __import__('imp').find_module('sphinx.ext.numfig')
+    extensions = ['sphinx.ext.numfig']
+except ImportError:
+    # 'pip install sphinx_numfig'
+    extensions = ['sphinx_numfig']
+
+# numfig:
+number_figures = True
+figure_caption_prefix = "Fig."
+
+source_suffix = '.rst'
+master_doc = 'index'
+pygments_style = 'sphinx'
+html_use_index = False
+
+pdf_documents = [('index', u'OPNFV', u'OPNFV Project', u'OPNFV')]
+pdf_fit_mode = "shrink"
+pdf_stylesheets = ['sphinx','kerning','a4']
+#latex_domain_indices = False
+#latex_use_modindex = False
+
+latex_elements = {
+    'printindex': '',
+}
+
+project = u'OPNFV: Template documentation config'
+copyright = u'%s, OPNFV' % datetime.date.today().year
+version = u'1.0.0'
+release = u'1.0.0'

diff --git a/docs/etc/opnfv-logo.png b/docs/etc/opnfv-logo.png
new file mode 100644 (file)
index 0000000..1519503
Binary files /dev/null and b/docs/etc/opnfv-logo.png differ

diff --git a/docs/Yardstick_task_templates.rst b/docs/to-be-reorganized/Yardstick_task_templates.rst
similarity index 100%
rename from docs/Yardstick_task_templates.rst
rename to docs/to-be-reorganized/Yardstick_task_templates.rst

diff --git a/docs/to-be-reorganized/index.rst b/docs/to-be-reorganized/index.rst
new file mode 100644 (file)
index 0000000..5e078d2
--- /dev/null
+++ b/docs/to-be-reorganized/index.rst
@@ -0,0 +1,31 @@
+.. OPNFV Release Engineering documentation, created by
+   sphinx-quickstart on Tue Jun  9 19:12:31 2015.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+.. image:: ../etc/opnfv-logo.png
+  :height: 40
+  :width: 200
+  :alt: OPNFV
+  :align: left
+
+Example Documentation table of contents
+=======================================
+
+Contents:
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   Yardstick_task_templates.rst
+   testcase_description_template.rst  
+
+Indices and tables
+==================
+
+* :ref:`search`
+
+Revision: _sha1_
+
+Build date: |today|

diff --git a/docs/templates/testcase_description_template.rst b/docs/to-be-reorganized/testcase_description_template.rst
similarity index 100%
rename from docs/templates/testcase_description_template.rst
rename to docs/to-be-reorganized/testcase_description_template.rst