From 397d79c2968811e983f8b38054526a96181367e4 Mon Sep 17 00:00:00 2001
From: Jeffrey Zhang <zhang.lei.fly@gmail.com>
Date: Wed, 15 Feb 2017 12:17:12 +0800
Subject: [PATCH] Fix doc format
Get follwing error when running tox -edocs
doc/bifrost.rst:91: D001 Line too long
doc/manila-hnas-guide.rst:28: D000 Title underline too short.
doc/manila-hnas-guide.rst:28: D000 Title underline too short.
doc/networking-guide.rst:93: D000 Title underline too short.
doc/networking-guide.rst:93: D000 Title underline too short.
doc/multinode.rst:14: D001 Line too long
doc/quickstart.rst:474: D001 Line too long
doc/vagrant-dev-env.rst:129: D001 Line too long
Change-Id: I88090487a4710547224361d29aaf8371f8340c28
---
doc/bifrost.rst | 4 ++--
doc/manila-hnas-guide.rst | 2 +-
doc/multinode.rst | 6 +++---
doc/networking-guide.rst | 2 +-
doc/quickstart.rst | 6 +++---
doc/vagrant-dev-env.rst | 4 ++--
6 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/doc/bifrost.rst b/doc/bifrost.rst
index 7afa1a6322..20c8fde0a3 100644
--- a/doc/bifrost.rst
+++ b/doc/bifrost.rst
@@ -88,8 +88,8 @@ Prepare bifrost configs
Create servers.yml
------------------
-The ``servers.yml`` will describing your physical nodes and list IPMI credentials.
-See bifrost dynamic inventory examples for more details.
+The ``servers.yml`` will describing your physical nodes and list IPMI
+credentials. See bifrost dynamic inventory examples for more details.
For example ``/etc/kolla/config/bifrost/servers.yml``
diff --git a/doc/manila-hnas-guide.rst b/doc/manila-hnas-guide.rst
index 1fe518cfdc..aa5e9f8aa7 100644
--- a/doc/manila-hnas-guide.rst
+++ b/doc/manila-hnas-guide.rst
@@ -25,7 +25,7 @@ Requirements
Supported shared file systems and operations
--------------------------------------------
+--------------------------------------------
The driver supports CIFS and NFS shares.
The following operations are supported:
diff --git a/doc/multinode.rst b/doc/multinode.rst
index 6b4d82524b..4d675a5d3d 100644
--- a/doc/multinode.rst
+++ b/doc/multinode.rst
@@ -11,9 +11,9 @@ Deploy a registry
A Docker registry is a locally hosted registry that replaces the need to pull
from the Docker Hub to get images. Kolla can function with or without a local
-registry, however for a multinode deployment some type of registry is mandatory.
-Only one registry must be deployed, although HA features exist for registry
-services.
+registry, however for a multinode deployment some type of registry is
+mandatory. Only one registry must be deployed, although HA features exist for
+registry services.
The Docker registry prior to version 2.3 has extremely bad performance because
all container data is pushed for every image rather than taking advantage of
diff --git a/doc/networking-guide.rst b/doc/networking-guide.rst
index ce3fc5a440..75be1be46e 100644
--- a/doc/networking-guide.rst
+++ b/doc/networking-guide.rst
@@ -90,7 +90,7 @@ For the source code, please refer to the following link:
Neutron VPNaaS (VPN-as-a-Service)
-================================
+=================================
Preparation and deployment
--------------------------
diff --git a/doc/quickstart.rst b/doc/quickstart.rst
index c1c8c175a8..bd418db9c4 100644
--- a/doc/quickstart.rst
+++ b/doc/quickstart.rst
@@ -469,9 +469,9 @@ View the images.
docker images
-Developers running from master are required to build container images as
-the Docker Hub does not contain built images for the master branch.
-Reference the `Building Container Images`_ for more advanced build configuration.
+Developers running from master are required to build container images as the
+Docker Hub does not contain built images for the master branch. Reference the
+`Building Container Images`_ for more advanced build configuration.
To build images using default parameters run:
diff --git a/doc/vagrant-dev-env.rst b/doc/vagrant-dev-env.rst
index a2162aceb9..963324ff8b 100644
--- a/doc/vagrant-dev-env.rst
+++ b/doc/vagrant-dev-env.rst
@@ -126,8 +126,8 @@ Once logged on the **operator** VM call the ``kolla-build`` utility::
kolla-build
-``kolla-build`` accept arguments as documented in `Building Container Images`_. It
-builds Docker images and pushes them to the local registry if the **push**
+``kolla-build`` accept arguments as documented in `Building Container Images`_.
+It builds Docker images and pushes them to the local registry if the **push**
option is enabled (in Vagrant this is the default behaviour).
Deploying OpenStack with Kolla