diff options
| author |   Ryota MIBU <r-mibu@cq.jp.nec.com> | 2016-02-02 00:24:22 +0900 |
|---|---|---|
| committer | Ryota MIBU <r-mibu@cq.jp.nec.com> | 2016-02-02 00:24:22 +0900 |
| commit | 9351f9aed9383b85173215cf892eef5b3fc44fc3 (patch) | |
| tree | 0667990aa73e0653174fd3a8f398a943bd658c18 /docs/userguide | |
| parent | 145ed01de3d50f82a9ed25ec1421651b8248df63 (diff) | |
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>
Diffstat (limited to 'docs/userguide')
| -rw-r--r-- | docs/userguide/abstract.rst | 3 | ||||
| -rw-r--r-- | docs/userguide/feature-usage.rst | 1 | ||||
| -rw-r--r-- | docs/userguide/general-system.rst | 1 | ||||
| -rw-r--r-- | docs/userguide/index.rst | 8 | ||||
| -rw-r--r-- | docs/userguide/introduction.rst | 5 | ||||
| -rw-r--r-- | docs/userguide/onos.rst | 2 | ||||
| -rw-r--r-- | docs/userguide/opendaylight.rst | 2 | ||||
| -rw-r--r-- | docs/userguide/openstack.rst | 2 | ||||
| -rw-r--r-- | docs/userguide/ovs.rst | 2 |
9 files changed, 13 insertions, 13 deletions
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 |