From 9351f9aed9383b85173215cf892eef5b3fc44fc3 Mon Sep 17 00:00:00 2001 From: Ryota MIBU Date: Tue, 2 Feb 2016 00:24:22 +0900 Subject: 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 --- docs/configguide/abstract.rst | 3 ++- docs/configguide/configoptions.rst | 3 ++- docs/configguide/feature-config.rst | 1 + docs/configguide/index.rst | 11 ++--------- docs/configguide/installer-config.rst | 1 + docs/configguide/introduction.rst | 14 -------------- docs/configguide/post-install.rst | 1 + docs/platformoverview/deploymenttools.rst | 7 ++----- docs/platformoverview/index.rst | 16 ++-------------- docs/platformoverview/introduction.rst | 6 ++---- docs/platformoverview/softwarearchitecture.rst | 4 ++-- docs/platformoverview/testcasesframework.rst | 8 ++------ docs/userguide/abstract.rst | 3 ++- docs/userguide/feature-usage.rst | 1 + docs/userguide/general-system.rst | 1 + docs/userguide/index.rst | 8 ++------ docs/userguide/introduction.rst | 5 +++-- docs/userguide/onos.rst | 2 +- docs/userguide/opendaylight.rst | 2 +- docs/userguide/openstack.rst | 2 +- docs/userguide/ovs.rst | 2 +- 21 files changed, 32 insertions(+), 69 deletions(-) delete mode 100644 docs/configguide/introduction.rst diff --git a/docs/configguide/abstract.rst b/docs/configguide/abstract.rst index 608ad0688..8005d86dd 100644 --- 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 bf3dc3d08..f977ccf20 100644 --- 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 df9728bb9..1053807ad 100644 --- 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 0a47f1589..9e43a174f 100644 --- 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 89632ea3f..00596db92 100644 --- 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 index 058514e20..000000000 --- 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 88c12067d..663080d2a 100644 --- 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 996bca263..09ac5c1f5 100644 --- 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 6f01e571a..4c6db1200 100644 --- 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 495655106..6d7c4c2e7 100644 --- 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 c8593c4d1..6398bb0ed 100644 --- 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 f06c98b7a..e5cdaca44 100644 --- 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 502c3fb5f..c2d93b98c 100644 --- 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 ea1e9e54e..8c69694b2 100644 --- 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 364fbce32..8920a2519 100644 --- 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 023c1d317..6ad11efef 100644 --- 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 9ac9f0814..c1ab145bc 100644 --- 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 d4fdb59c1..c68801eaf 100644 --- 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 3616307e7..6e43c05c5 100644 --- 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 069dc4b76..daeb5240f 100644 --- 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 10e65baeb..9209ac61c 100644 --- 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 -- cgit 1.2.3-korg