fix section headers in consistent rule

'*' with overline: document title (placed before toctree)
'=' with overline: sections
'=': subsections
'-': subsubsections

Change-Id: Ia91ec0c4f95185eac911e972a07ebc7fdae372f4
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
(cherry picked from commit 9351f9aed9383b85173215cf892eef5b3fc44fc3)

diff --git a/docs/configguide/abstract.rst b/docs/configguide/abstract.rst
index 608ad06..8005d86 100644 (file)
--- a/docs/configguide/abstract.rst
+++ b/docs/configguide/abstract.rst
@@ -1,5 +1,6 @@
+========
 Abstract
---------
+========
 
 This document provides guidance and instructions for the configuration
 of the Brahmaputra release of OPNFV.

diff --git a/docs/configguide/configoptions.rst b/docs/configguide/configoptions.rst
index bf3dc3d..f977ccf 100644 (file)
--- a/docs/configguide/configoptions.rst
+++ b/docs/configguide/configoptions.rst
@@ -1,3 +1,4 @@
+=====================
 Configuration Options
 =====================
 
@@ -8,7 +9,7 @@ components such as OpenStack, OpenDaylight, OVS, KVM etc. where each scenario wi
 include different source components or configurations.
 
 OPNFV Scenario's
-----------------
+================
 
 Each OPNFV scenario provides unique features and capabilities, it is important to understand
 your target platform capabilities before installing and configuring your target scenario.

diff --git a/docs/configguide/feature-config.rst b/docs/configguide/feature-config.rst
index df9728b..1053807 100644 (file)
--- a/docs/configguide/feature-config.rst
+++ b/docs/configguide/feature-config.rst
@@ -1,3 +1,4 @@
+=====================
 Feature Configuration
 =====================
 

diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst
index 0a47f15..9e43a17 100644 (file)
--- a/docs/configguide/index.rst
+++ b/docs/configguide/index.rst
@@ -1,19 +1,12 @@
+*************************
 OPNFV Configuration Guide
-=========================
-
-Contents:
+*************************
 
 .. toctree::
    :maxdepth: 2
 
    ./abstract
-   ./introduction
    ./configoptions
    ./installer-config
    ./feature-config
    ./post-install
-
-Indices and tables
-==================
-
-* :ref:`search`

diff --git a/docs/configguide/installer-config.rst b/docs/configguide/installer-config.rst
index 89632ea..00596db 100644 (file)
--- a/docs/configguide/installer-config.rst
+++ b/docs/configguide/installer-config.rst
@@ -1,3 +1,4 @@
+=======================
 Installer Configuration
 =======================
 

diff --git a/docs/configguide/introduction.rst b/docs/configguide/introduction.rst
deleted file mode 100644 (file)
index 058514e..0000000
--- a/docs/configguide/introduction.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-Scope
-=====
-
-
-Using this guide
-----------------
-This section is probably wrong as we should dive straight into this, we have an abstract already.
-
-Pre-requisites
---------------
-
-
-
-

diff --git a/docs/configguide/post-install.rst b/docs/configguide/post-install.rst
index 88c1206..663080d 100644 (file)
--- a/docs/configguide/post-install.rst
+++ b/docs/configguide/post-install.rst
@@ -1,3 +1,4 @@
+=============================
 Post Configuration Activities
 =============================
 

diff --git a/docs/platformoverview/deploymenttools.rst b/docs/platformoverview/deploymenttools.rst
index 996bca2..09ac5c1 100644 (file)
--- a/docs/platformoverview/deploymenttools.rst
+++ b/docs/platformoverview/deploymenttools.rst
@@ -1,6 +1,6 @@
-----------------
+================
 Deployment Tools
-----------------
+================
 
 Brahmaputra provides 4 different installers.
 
@@ -41,6 +41,3 @@ Joid
 
 Editors note:
 Just a high level intro and link to the main joid documents.
-
-
-

diff --git a/docs/platformoverview/index.rst b/docs/platformoverview/index.rst
index 6f01e57..4c6db12 100644 (file)
--- a/docs/platformoverview/index.rst
+++ b/docs/platformoverview/index.rst
@@ -1,13 +1,6 @@
-.. OPNFV Platform Overview documentation master file, created by
-   sphinx-quickstart on Tue Nov 24 10:30:29 2015.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
+********************************
 OPNFV Platform Overview document
-================================
-
-
-Contents:
+********************************
 
 .. toctree::
    :maxdepth: 2
@@ -16,8 +9,3 @@ Contents:
    ./softwarearchitecture.rst
    ./deploymenttools.rst
    ./testcasesframework.rst
-
-Indices and tables
-==================
-
-* :ref:`search`

diff --git a/docs/platformoverview/introduction.rst b/docs/platformoverview/introduction.rst
index 4956551..6d7c4c2 100644 (file)
--- a/docs/platformoverview/introduction.rst
+++ b/docs/platformoverview/introduction.rst
@@ -1,6 +1,6 @@
-------------------------
+============
 Introduction
-------------------------
+============
 
 The OPNFV project provides different kinds of output to its users:
 
@@ -62,5 +62,3 @@ later releases of OPNFV. Thus they are not part of a release package.
 Also community labs are independent of releases. Only the lab description is included in
 the release and describes the requirements of a lab to successfully run Brahmaputra
 deployments.
-
-

diff --git a/docs/platformoverview/softwarearchitecture.rst b/docs/platformoverview/softwarearchitecture.rst
index c8593c4..6398bb0 100644 (file)
--- a/docs/platformoverview/softwarearchitecture.rst
+++ b/docs/platformoverview/softwarearchitecture.rst
@@ -1,6 +1,6 @@
-------------------------
+========================
 Target software platform
-------------------------
+========================
 
 Software architecture
 =====================

diff --git a/docs/platformoverview/testcasesframework.rst b/docs/platformoverview/testcasesframework.rst
index f06c98b..e5cdaca 100644 (file)
--- a/docs/platformoverview/testcasesframework.rst
+++ b/docs/platformoverview/testcasesframework.rst
@@ -1,10 +1,6 @@
------------------------
+=======================
 Testcases and Framework
------------------------
+=======================
 
 Editors note:
 Just a high level description about the different types of tests and the role of yardstick as central framework.
-
-
-
-

diff --git a/docs/userguide/abstract.rst b/docs/userguide/abstract.rst
index 502c3fb..c2d93b9 100644 (file)
--- a/docs/userguide/abstract.rst
+++ b/docs/userguide/abstract.rst
@@ -1,5 +1,6 @@
+========
 Abstract
---------
+========
 
 OPNFV is a collaborative project aimed at providing a variety of virtualisation
 deployments intended to host applications serving the networking and carrier industry.

diff --git a/docs/userguide/feature-usage.rst b/docs/userguide/feature-usage.rst
index ea1e9e5..8c69694 100644 (file)
--- a/docs/userguide/feature-usage.rst
+++ b/docs/userguide/feature-usage.rst
@@ -1,3 +1,4 @@
+==========================
 Using Brahmaputra Features
 ==========================
 

diff --git a/docs/userguide/general-system.rst b/docs/userguide/general-system.rst
index 364fbce..8920a25 100644 (file)
--- a/docs/userguide/general-system.rst
+++ b/docs/userguide/general-system.rst
@@ -1,3 +1,4 @@
+============================
 Usage of platform components
 ============================
 

diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
index 023c1d3..6ad11ef 100644 (file)
--- a/docs/userguide/index.rst
+++ b/docs/userguide/index.rst
@@ -1,5 +1,6 @@
+****************
 OPNFV User Guide
-================
+****************
 
 .. toctree::
    :maxdepth: 2
@@ -8,8 +9,3 @@ OPNFV User Guide
    ./introduction
    ./general-system
    ./feature-usage
-
-Indices and tables
-==================
-
-* :ref:`search`

diff --git a/docs/userguide/introduction.rst b/docs/userguide/introduction.rst
index 9ac9f08..c1ab145 100644 (file)
--- a/docs/userguide/introduction.rst
+++ b/docs/userguide/introduction.rst
@@ -1,3 +1,4 @@
+========
 Overview
 ========
 
@@ -13,7 +14,7 @@ enable specific features and capabilities in the platform that can be leveraged
 OPNFV user community.
 
 OPNFV Scenarios
-----------------
+===============
 
 Each OPNFV scenario provides unique features and capabilities, it is important to
 ensure you have a scenario deployed on your infrastructure that provides the right capabilities
@@ -37,7 +38,7 @@ provide information about the specific use cases that have been validated and ar
 on your deployment.
 
 General usage guidelines
-------------------------
+========================
 
 The user guide for OPNFV features and capabilities provide step by step instructions
 for using features that have been configured according to the installation and configuration

diff --git a/docs/userguide/onos.rst b/docs/userguide/onos.rst
index d4fdb59..c68801e 100644 (file)
--- a/docs/userguide/onos.rst
+++ b/docs/userguide/onos.rst
@@ -1,5 +1,5 @@
 ONOS User Guide
----------------
+===============
 
 Add ONOS specific user guide information here.
 Needs to include OPNFV default ports and addresses and

diff --git a/docs/userguide/opendaylight.rst b/docs/userguide/opendaylight.rst
index 3616307..6e43c05 100644 (file)
--- a/docs/userguide/opendaylight.rst
+++ b/docs/userguide/opendaylight.rst
@@ -1,5 +1,5 @@
 OpenDaylight User Guide
------------------------
+=======================
 
 Add opendaylight specific user guide information here.
 Needs to include OPNFV default ports and addresses and

diff --git a/docs/userguide/openstack.rst b/docs/userguide/openstack.rst
index 069dc4b..daeb524 100644 (file)
--- a/docs/userguide/openstack.rst
+++ b/docs/userguide/openstack.rst
@@ -1,5 +1,5 @@
 OpenStack User Guide
---------------------
+====================
 
 Add openstack specific user guide information here.
 Needs to include OPNFV default ports and addresses and

diff --git a/docs/userguide/ovs.rst b/docs/userguide/ovs.rst
index 10e65ba..9209ac6 100644 (file)
--- a/docs/userguide/ovs.rst
+++ b/docs/userguide/ovs.rst
@@ -1,5 +1,5 @@
 OVS User Guide
---------------
+==============
 
 Add OVS specific user guide information here.
 Needs to include OPNFV default ports and addresses and