summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFatih Degirmenci <fatih.degirmenci@ericsson.com>2015-11-27 12:40:35 +0100
committerJonas Bjurel <jonas.bjurel@ericsson.com>2015-11-29 11:50:58 +0000
commit0001e14a6555f0c073b332af247c921202cb74a6 (patch)
tree33dfd14e614f890beda6d5fc1ff3628145fb87b0
parent4294e875a20fda54e6a4fdf72d5850cd21860f22 (diff)
Enable new doc generation for fuel
The work to unify the doc generation for all OPNFV projects is currently ongoing. This change adjusts docs directory structure for fuel project. Trigger the fuel-verify build without cache. verify: no-cache Change-Id: Ie430b662c5b50d38efe0c8a1eb50aa8f01c85e85 Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
-rw-r--r--docs/.DS_Storebin6148 -> 0 bytes
-rw-r--r--docs/build-instructions.rst (renamed from docs/src/build-instructions.rst)0
-rw-r--r--docs/etc/conf.py34
-rw-r--r--docs/etc/opnfv-logo.pngbin0 -> 2829 bytes
-rw-r--r--docs/index.rst29
-rw-r--r--docs/installation-instructions.rst (renamed from docs/src/installation-instructions.rst)0
-rw-r--r--docs/release-notes.rst (renamed from docs/src/release-notes.rst)0
7 files changed, 63 insertions, 0 deletions
diff --git a/docs/.DS_Store b/docs/.DS_Store
deleted file mode 100644
index 9a874b576..000000000
--- a/docs/.DS_Store
+++ /dev/null
Binary files differ
diff --git a/docs/src/build-instructions.rst b/docs/build-instructions.rst
index 08b560375..08b560375 100644
--- a/docs/src/build-instructions.rst
+++ b/docs/build-instructions.rst
diff --git a/docs/etc/conf.py b/docs/etc/conf.py
new file mode 100644
index 000000000..006fc7027
--- /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: Fuel'
+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/index.rst b/docs/index.rst
new file mode 100644
index 000000000..40e68b750
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,29 @@
+.. 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
+
+Fuel@OPNFV
+=======================================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 4
+ :titlesonly:
+
+ build-instructions.rst
+ installation-instructions.rst
+ release-notes.rst
+
+* :ref:`search`
+
+Revision: _sha1_
+
+Build date: |today|
diff --git a/docs/src/installation-instructions.rst b/docs/installation-instructions.rst
index aedbb53d5..aedbb53d5 100644
--- a/docs/src/installation-instructions.rst
+++ b/docs/installation-instructions.rst
diff --git a/docs/src/release-notes.rst b/docs/release-notes.rst
index 435789767..435789767 100644
--- a/docs/src/release-notes.rst
+++ b/docs/release-notes.rst