summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorRyota MIBU <r-mibu@cq.jp.nec.com>2016-02-23 19:03:56 +0900
committerRyota MIBU <r-mibu@cq.jp.nec.com>2016-02-23 19:55:37 +0900
commit0b92087277d4f030a936f8d58595047c5d47f158 (patch)
treeef8c480d7b2e5b4c8b9b4db49797989ed6cfa297 /docs
parent7a402764fdb92f8f09c67c2345355a52c1348572 (diff)
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
Diffstat (limited to 'docs')
-rw-r--r--docs/build-instruction.rst9
-rw-r--r--docs/conf.py28
-rw-r--r--docs/configguide/installerconfig.rst4
-rw-r--r--docs/index.rst22
-rw-r--r--docs/installation-instruction.rst5
-rw-r--r--docs/release-notes.rst4
6 files changed, 38 insertions, 34 deletions
diff --git a/docs/build-instruction.rst b/docs/build-instruction.rst
index d5721af0b..254c0d3f2 100644
--- 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
index 000000000..6cd69313d
--- /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 ea08b6d31..51c1f5b2f 100644
--- 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 fd61a5201..6bba3aaf1 100644
--- 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 aaf96becb..f7125816d 100644
--- 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 253859bfe..4f42a7028 100644
--- 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
~~~~~~~~~~~~~~~~~