Merge "Fix sphinx warnings"
authorThanh Ha <thanh.ha@linuxfoundation.org>
Sat, 13 Aug 2016 16:30:36 +0000 (16:30 +0000)
committerGerrit Code Review <gerrit@opendaylight.org>
Sat, 13 Aug 2016 16:30:36 +0000 (16:30 +0000)
docs/documentation.rst
docs/getting-started-guide/project-specific-guides/yangide.rst

index fdee59cc64474ac43e009a3226c840bf9cde21e5..0e0e9a009284dd613eb016a10ad66c1bb9fca9a6 100644 (file)
@@ -29,7 +29,7 @@ That being said, assuming that the content is usable, the bias should
 be toward merging it rather than blocking on relatively minor edits.
 
 Formatting Preferences
-^^^^^^^^^^^^^^^^^^^^^^
+----------------------
 
 In general, the documentation team has focused on trying to make sure
 that the instructions are comprehensible, but not being overly pedantic
@@ -40,7 +40,7 @@ following, generally they aren't a reason to -1 in and of themselves:
 * Line wrapping at something reasonable, i.e., 72–100 characters
 
 Key terms
-^^^^^^^^^
+---------
 
 * Functionality: something useful a project provides abstractly
 * Feature: a Karaf feature that somebody could install
@@ -54,7 +54,7 @@ Key terms
     other terms is hard.
 
 Common writing style mistakes
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+-----------------------------
 
 * In per-project user documentation, you should never say *git clone*,
   but should assume people have downloaded and installed the controller
@@ -72,7 +72,7 @@ Common writing style mistakes
   project.
 
 Grammar Preferences
-"""""""""""""""""""
+^^^^^^^^^^^^^^^^^^^
 
 * Avoid contractions: use cannot instead of can't, it is instead of
   it's, and the like.
index ffcff46c02a3c31edd035c78e0215357a7709d85..54b5593679acb0d799c7f75ff7400759913ec882 100644 (file)
@@ -1,5 +1,5 @@
 YANG IDE Installation Guide
-==========================
+===========================
 
 Overview
 --------
@@ -11,7 +11,7 @@ references the appropriate OpenDaylight dependencies, along with a
 sample Yang model file (acme-system.yang).
 
 Pre Requisites for Installing YANG IDE
--------------------------------------
+--------------------------------------
 
 * YANG IDE has the same hardware requirements as the Eclipse IDE, which
   is about the same as the hardware requirements for Java 7.
@@ -35,7 +35,7 @@ the correct platform (for instance, 32-bit or 64-bit).
 
 
 Installing YANG IDE
-------------------
+-------------------
 
 The YANG IDE plugin can be installed by using the public update site URL
 provided, which is http://abc.def .
@@ -198,7 +198,7 @@ If you already had the "YANG IDE" plugin from "Xored", you will need to
 uninstall that plugin before you install this one.
 
 Uninstalling YANG IDE
---------------------
+---------------------
 
 Uninstalling the YANG IDE plugin is the same as uninstalling any other Eclipse plugin.