Move documents to new directory structure 83/3183/1
authorAric Gardner <agardner@linuxfoundation.org>
Tue, 10 Nov 2015 18:38:38 +0000 (13:38 -0500)
committerAric Gardner <agardner@linuxfoundation.org>
Tue, 10 Nov 2015 18:42:11 +0000 (13:42 -0500)
added index.rst

Change-Id: I5af95b40afd5443176c1054085b597a435c31b1b
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
docs/arno/enable_docu_gen.rst [moved from docs/enable_docu_gen.rst with 100% similarity]
docs/arno/images/smiley.png [moved from docs/images/smiley.png with 100% similarity]
docs/arno/index.rst [new file with mode: 0644]
docs/arno/opnfv-jjb-usage.rst [moved from docs/opnfv-jjb-usage.rst with 100% similarity]
docs/arno/opnfvdocs_info.rst [moved from docs/opnfvdocs_info.rst with 100% similarity]
docs/arno/other_options_for_docu_gen.rst [moved from docs/other_options_for_docu_gen.rst with 100% similarity]
docs/etc/conf.py [new file with mode: 0644]
docs/etc/opnfv-logo.png [new file with mode: 0644]
docs/templates/index.rst [new file with mode: 0644]

diff --git a/docs/arno/index.rst b/docs/arno/index.rst
new file mode 100644 (file)
index 0000000..994a20d
--- /dev/null
@@ -0,0 +1,34 @@
+.. 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
+
+   enable_docu_gen.rst
+   opnfvdocs_info.rst
+   opnfv-jjb-usage.rst
+   other_options_for_docu_gen.rst
+
+
+Indices and tables
+==================
+
+* :ref:`search`
+
+Revision: _sha1_
+
+Build date: |today|
diff --git a/docs/etc/conf.py b/docs/etc/conf.py
new file mode 100644 (file)
index 0000000..0066035
--- /dev/null
@@ -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/templates/index.rst b/docs/templates/index.rst
new file mode 100644 (file)
index 0000000..603615c
--- /dev/null
@@ -0,0 +1,34 @@
+.. 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
+
+   build-instructions.rst
+   installation-instructions.rst
+   LICENSE.rst
+   release-notes.rst
+
+
+Indices and tables
+==================
+
+* :ref:`search`
+
+Revision: _sha1_
+
+Build date: |today|