summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAric Gardner <agardner@linuxfoundation.org>2015-11-10 13:38:38 -0500
committerAric Gardner <agardner@linuxfoundation.org>2015-11-10 13:42:11 -0500
commit256683072fb4c5b0bba36ddfd273b9bab0213945 (patch)
treef8c49b522e557f6417a2897fdd2a65dd8a0e3dc4
parent7d169759055aaa86635202a901df37d5f05c03ed (diff)
Move documents to new directory structure
added index.rst Change-Id: I5af95b40afd5443176c1054085b597a435c31b1b Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
-rw-r--r--docs/arno/enable_docu_gen.rst (renamed from docs/enable_docu_gen.rst)0
-rw-r--r--docs/arno/images/smiley.png (renamed from docs/images/smiley.png)bin317247 -> 317247 bytes
-rw-r--r--docs/arno/index.rst34
-rw-r--r--docs/arno/opnfv-jjb-usage.rst (renamed from docs/opnfv-jjb-usage.rst)0
-rw-r--r--docs/arno/opnfvdocs_info.rst (renamed from docs/opnfvdocs_info.rst)0
-rw-r--r--docs/arno/other_options_for_docu_gen.rst (renamed from docs/other_options_for_docu_gen.rst)0
-rw-r--r--docs/etc/conf.py34
-rw-r--r--docs/etc/opnfv-logo.pngbin0 -> 2829 bytes
-rw-r--r--docs/templates/index.rst34
9 files changed, 102 insertions, 0 deletions
diff --git a/docs/enable_docu_gen.rst b/docs/arno/enable_docu_gen.rst
index 6f02cdacd..6f02cdacd 100644
--- a/docs/enable_docu_gen.rst
+++ b/docs/arno/enable_docu_gen.rst
diff --git a/docs/images/smiley.png b/docs/arno/images/smiley.png
index 04023d133..04023d133 100644
--- a/docs/images/smiley.png
+++ b/docs/arno/images/smiley.png
Binary files differ
diff --git a/docs/arno/index.rst b/docs/arno/index.rst
new file mode 100644
index 000000000..994a20d51
--- /dev/null
+++ b/docs/arno/index.rst
@@ -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/opnfv-jjb-usage.rst b/docs/arno/opnfv-jjb-usage.rst
index aabfda7ae..aabfda7ae 100644
--- a/docs/opnfv-jjb-usage.rst
+++ b/docs/arno/opnfv-jjb-usage.rst
diff --git a/docs/opnfvdocs_info.rst b/docs/arno/opnfvdocs_info.rst
index 1c78eeaf0..1c78eeaf0 100644
--- a/docs/opnfvdocs_info.rst
+++ b/docs/arno/opnfvdocs_info.rst
diff --git a/docs/other_options_for_docu_gen.rst b/docs/arno/other_options_for_docu_gen.rst
index ea6ad2598..ea6ad2598 100644
--- a/docs/other_options_for_docu_gen.rst
+++ b/docs/arno/other_options_for_docu_gen.rst
diff --git a/docs/etc/conf.py b/docs/etc/conf.py
new file mode 100644
index 000000000..006603516
--- /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
index 000000000..1519503eb
--- /dev/null
+++ b/docs/etc/opnfv-logo.png
Binary files differ
diff --git a/docs/templates/index.rst b/docs/templates/index.rst
new file mode 100644
index 000000000..603615ccb
--- /dev/null
+++ b/docs/templates/index.rst
@@ -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|