docs: fix figure placement and old format

This patch makes figures in the same place written in source rst files,
and also fixes old format of rst files and logo images.

Note: lisence headers should be added in another change with relevant
copyrights.

Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
Change-Id: Ibc5ca44031ef5946079bdf251935100f762a87b6

diff --git a/docs/build-instruction.rst b/docs/build-instruction.rst
index d5721af..254c0d3 100644 (file)
--- a/docs/build-instruction.rst
+++ b/docs/build-instruction.rst
@@ -1,9 +1,6 @@
-================================================================================================
+=================================================================================================
 OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
-================================================================================================
-
-.. contents:: Table of Contents
-   :backlinks: none
+=================================================================================================
 
 License
 =======
@@ -87,7 +84,7 @@ Then restart docker:
 
 .. code-block:: console
 
-$ sudo service docker restart
+    $ sudo service docker restart
 
 Setting up OPNFV Gerrit in order to being able to clone the code
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644 (file)
index 0000000..6cd6931
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,28 @@
+# SPDX-license-identifier: Apache-2.0
+##############################################################################
+# Copyright (c) 2016 Linux Foundation and others.
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+##############################################################################
+
+# Copied from releng/docs/etc/conf.py
+extensions = ['sphinxcontrib.httpdomain',
+              'sphinx.ext.autodoc',
+              'sphinx.ext.viewcode',
+              'sphinx.ext.napoleon']
+
+needs_sphinx = '1.3'
+master_doc = 'index'
+pygments_style = 'sphinx'
+
+html_use_index = False
+numfig = True
+html_logo = 'opnfv-logo.png'
+
+latex_domain_indices = False
+latex_logo = 'opnfv-logo.png'
+
+# addtional config
+latex_elements = {'figure_align': 'H'}

diff --git a/docs/configguide/installerconfig.rst b/docs/configguide/installerconfig.rst
index ea08b6d..51c1f5b 100644 (file)
--- a/docs/configguide/installerconfig.rst
+++ b/docs/configguide/installerconfig.rst
@@ -69,7 +69,7 @@ Following high level hardware requirements must be met:
 +--------------------+------------------------------------------------------+
 | **HW Aspect**      | **Requirement**                                      |
 |                    |                                                      |
-+--------------------+------------------------------------------------------+
++====================+======================================================+
 | **# of nodes**     | Minimum 5 (3 for non redundant deployment):          |
 |                    |                                                      |
 |                    | - 1 Fuel deployment master (may be virtualized)      |
@@ -155,7 +155,7 @@ developed by OPNFV:
 +--------------------+------------------------------------------------------+
 |  **Plugin name**   | **Short description**                                |
 |                    |                                                      |
-+--------------------+------------------------------------------------------+
++====================+======================================================+
 | OpenDaylight       | OpenDaylight provides an open-source SDN Controller  |
 |                    | providing networking features such as L2 and L3      |
 |                    | network control, "Service Function Chaining",        |

diff --git a/docs/index.rst b/docs/index.rst
index fd61a52..6bba3aa 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -4,32 +4,16 @@
 .. You should have received a copy of the license along with this work.
 .. If not, see <http://creativecommons.org/licenses/by/4.0/>.
 
-.. 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:: opnfv-logo.png
-  :height: 40
-  :width: 200
-  :alt: OPNFV
-  :align: left
-
+**********
 Fuel@OPNFV
-=======================================
-
-Contents:
+**********
 
 .. toctree::
    :maxdepth: 4
-   :titlesonly:
 
    build-instruction.rst
    installation-instruction.rst
    release-notes.rst
 
-* :ref:`search`
-
-Revision: _sha1_
+.. :titlesonly:
 
-Build date: |today|

diff --git a/docs/installation-instruction.rst b/docs/installation-instruction.rst
index aaf96be..f712581 100644 (file)
--- a/docs/installation-instruction.rst
+++ b/docs/installation-instruction.rst
@@ -2,9 +2,6 @@
 OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
 ========================================================================================================
 
-.. contents:: Table of Contents
-   :backlinks: none
-
 License
 =======
 
@@ -111,7 +108,7 @@ installation of Brahmaputra using Fuel:
 +--------------------+------------------------------------------------------+
 | **HW Aspect**      | **Requirement**                                      |
 |                    |                                                      |
-+--------------------+------------------------------------------------------+
++====================+======================================================+
 | **# of nodes**     | Minimum 5 (3 for non redundant deployment):          |
 |                    |                                                      |
 |                    | - 1 Fuel deployment master (may be virtualized)      |

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 253859b..4f42a70 100644 (file)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -2,9 +2,6 @@
 OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
 ============================================================================================
 
-.. contents:: Table of Contents
-   :backlinks: none
-
 License
 =======
 
@@ -121,6 +118,7 @@ comes with the following documentation:
 
 Reason for version
 ------------------
+
 Feature additions
 ~~~~~~~~~~~~~~~~~