summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAric Gardner <agardner@linuxfoundation.org>2015-09-11 15:45:39 -0400
committerAric Gardner <agardner@linuxfoundation.org>2015-09-11 15:45:39 -0400
commit081ace7342b175f8e06d8aa9848e2aa4557f65c8 (patch)
treed04866bd42a73bbe58faa873b72121476b8c31f2 /docs
parent72a6363bacadab1a0565ce71144471ba6f6d64ae (diff)
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: I3f3d8c9d7fceae90e0ed824b66bdaf7a8ea66328 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Diffstat (limited to 'docs')
-rw-r--r--docs/etc/conf.py34
-rw-r--r--docs/etc/opnfv-logo.pngbin0 -> 2829 bytes
-rw-r--r--docs/to-be-reorganized/NEWS.rst (renamed from docs/NEWS.rst)0
-rw-r--r--docs/to-be-reorganized/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml (renamed from docs/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml)0
-rw-r--r--docs/to-be-reorganized/images/TCLServerProperties.png (renamed from docs/images/TCLServerProperties.png)bin11667 -> 11667 bytes
-rw-r--r--docs/to-be-reorganized/index.rst33
-rw-r--r--docs/to-be-reorganized/installation.rst (renamed from docs/installation.rst)0
-rw-r--r--docs/to-be-reorganized/quickstart.rst (renamed from docs/quickstart.rst)2
-rw-r--r--docs/to-be-reorganized/vswitchperf_ltd.rst (renamed from docs/vswitchperf_ltd.rst)0
9 files changed, 68 insertions, 1 deletions
diff --git a/docs/etc/conf.py b/docs/etc/conf.py
new file mode 100644
index 00000000..00660351
--- /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 00000000..1519503e
--- /dev/null
+++ b/docs/etc/opnfv-logo.png
Binary files differ
diff --git a/docs/NEWS.rst b/docs/to-be-reorganized/NEWS.rst
index 3f01e371..3f01e371 100644
--- a/docs/NEWS.rst
+++ b/docs/to-be-reorganized/NEWS.rst
diff --git a/docs/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml b/docs/to-be-reorganized/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml
index d8351957..d8351957 100644
--- a/docs/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml
+++ b/docs/to-be-reorganized/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml
diff --git a/docs/images/TCLServerProperties.png b/docs/to-be-reorganized/images/TCLServerProperties.png
index 682de7c5..682de7c5 100644
--- a/docs/images/TCLServerProperties.png
+++ b/docs/to-be-reorganized/images/TCLServerProperties.png
Binary files differ
diff --git a/docs/to-be-reorganized/index.rst b/docs/to-be-reorganized/index.rst
new file mode 100644
index 00000000..1594d741
--- /dev/null
+++ b/docs/to-be-reorganized/index.rst
@@ -0,0 +1,33 @@
+.. 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
+
+ quickstart.rst
+ NEWS.rst
+ vswitchperf_ltd.rst
+ installation.rst
+
+Indices and tables
+==================
+
+* :ref:`search`
+
+Revision: _sha1_
+
+Build date: |today|
diff --git a/docs/installation.rst b/docs/to-be-reorganized/installation.rst
index 90de7a0a..90de7a0a 100644
--- a/docs/installation.rst
+++ b/docs/to-be-reorganized/installation.rst
diff --git a/docs/quickstart.rst b/docs/to-be-reorganized/quickstart.rst
index e5b433fa..8dead99c 100644
--- a/docs/quickstart.rst
+++ b/docs/to-be-reorganized/quickstart.rst
@@ -16,7 +16,7 @@ The vSwitch must support Open Flow 1.3 or greater.
Installation
------------
-Follow the `installation instructions <installation.md>`__ to install.
+Follow the `installation instructions <installation.html>`__ to install.
IXIA Setup
----------
diff --git a/docs/vswitchperf_ltd.rst b/docs/to-be-reorganized/vswitchperf_ltd.rst
index 9277535c..9277535c 100644
--- a/docs/vswitchperf_ltd.rst
+++ b/docs/to-be-reorganized/vswitchperf_ltd.rst