From 28c87f4190fa24b6323592d87ff708ebcd69b780 Mon Sep 17 00:00:00 2001
From: Ryota MIBU <r-mibu@cq.jp.nec.com>
Date: Fri, 26 Feb 2016 02:31:45 +0900
Subject: migrate new docs template and fix pdf view
JIRA: SFC-31
Change-Id: I9e46c799083553b8c6142f018cd71a638006a449
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
(cherry picked from commit 534a1d1aeb178985bd884449377b2f4d671e14cf)
---
docs/design/architecture.rst | 3 +++
docs/design/definitions.rst | 3 +++
docs/design/index.rst | 22 +++++-----------------
docs/design/introduction.rst | 24 +++++++-----------------
docs/design/requirements.rst | 3 +++
docs/design/usecases.rst | 4 +++-
docs/etc/conf.py | 35 -----------------------------------
docs/etc/opnfv-logo.png | Bin 2829 -> 0 bytes
8 files changed, 24 insertions(+), 70 deletions(-)
delete mode 100644 docs/etc/conf.py
delete mode 100644 docs/etc/opnfv-logo.png
diff --git a/docs/design/architecture.rst b/docs/design/architecture.rst
index d2a1bb4d..d6779e9a 100644
--- a/docs/design/architecture.rst
+++ b/docs/design/architecture.rst
@@ -1,3 +1,6 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
Architecture
------------
diff --git a/docs/design/definitions.rst b/docs/design/definitions.rst
index 38263044..85416fb8 100644
--- a/docs/design/definitions.rst
+++ b/docs/design/definitions.rst
@@ -1,3 +1,6 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
Definitions
-----------
diff --git a/docs/design/index.rst b/docs/design/index.rst
index 138a1817..f13d575b 100644
--- a/docs/design/index.rst
+++ b/docs/design/index.rst
@@ -1,28 +1,16 @@
-.. OPNFV Service Function Chaining (SFC) documentation
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
-.. image:: ../etc/opnfv-logo.png
- :height: 40
- :width: 200
- :alt: OPNFV
- :align: left
-|
-|
+*******************************
Service Function Chaining (SFC)
-===============================
-
-Contents:
+*******************************
.. toctree::
:numbered:
- :maxdepth: 4
+ :maxdepth: 2
introduction.rst
definitions.rst
usecases.rst
architecture.rst
requirements.rst
-
-Indices and tables
-==================
-
-* :ref:`search`
diff --git a/docs/design/introduction.rst b/docs/design/introduction.rst
index 441ed999..13584e79 100644
--- a/docs/design/introduction.rst
+++ b/docs/design/introduction.rst
@@ -1,23 +1,13 @@
-.. two dots create a comment. please leave this logo at the top of each of your rst files.
-.. image:: ../etc/opnfv-logo.png
- :height: 40
- :width: 200
- :alt: OPNFV
- :align: left
-.. these two pipes are to seperate the logo from the first title
-|
-|
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
Introduction
------------
-..
- This work is licensed under a Creative Commons Attribution 3.0 Unported License.
-
- http://creativecommons.org/licenses/by/3.0/legalcode
-
.. NOTE::
This is the working documentation for the SFC project.
-The `OPNFV Service Function Chaining (SFC) <https://wiki.opnfv.org/sfc>`_ project aims to provide the ability to define an ordered list of a network services (e.g. firewalls, NAT, QoS). These service are then "stitched" together in the network to create a service chain. This project provides the infrastructure to install the upstream ODL SFC implementation project in an NFV environment.
-
-
+The `OPNFV Service Function Chaining (SFC) <https://wiki.opnfv.org/sfc>`_ project aims to provide the ability to define
+an ordered list of a network services (e.g. firewalls, NAT, QoS).
+These service are then "stitched" together in the network to create a service chain.
+This project provides the infrastructure to install the upstream ODL SFC implementation project in an NFV environment.
diff --git a/docs/design/requirements.rst b/docs/design/requirements.rst
index 3a716351..3a790200 100644
--- a/docs/design/requirements.rst
+++ b/docs/design/requirements.rst
@@ -1,3 +1,6 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
Requirements
------------
diff --git a/docs/design/usecases.rst b/docs/design/usecases.rst
index b42fcbde..0f22491d 100644
--- a/docs/design/usecases.rst
+++ b/docs/design/usecases.rst
@@ -1,10 +1,12 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
Use Cases
---------
This section outlines the Brahmaputra use cases driving the initial OPNFV
SFC implementation.
-
The use cases targeted in the OPNFV SFC Brahmaputra release focus on creating
simple Service Chains using Firewall Service Functions. As can be seen in the
following diagram, 2 service chains are created, each through a different
diff --git a/docs/etc/conf.py b/docs/etc/conf.py
deleted file mode 100644
index 9a0c229a..00000000
--- a/docs/etc/conf.py
+++ /dev/null
@@ -1,35 +0,0 @@
-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
-html_theme = 'sphinx_rtd_theme'
-
-pdf_documents = [('index', u'SFC', u'SFC 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: Service Function Chaining (SFC)'
-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
deleted file mode 100644
index 1519503e..00000000
Binary files a/docs/etc/opnfv-logo.png and /dev/null differ
--
cgit