Add doc8 into pep8 check to scan rst files

This change will help fix pep8 issues of all *.rst files
in the project and checking for new files.

Change-Id: Ib06aeb7fa76bd387d76c23bc3f8ecca89332d989
Co-authored-By: Hoang Trung Hieu <hieuht@vn.fujitsu.com>
This commit is contained in:
Nguyen Van Trung 2017-11-29 13:09:58 +07:00
parent f664ea3deb
commit 7047a329b5
7 changed files with 20 additions and 15 deletions

View File

@ -66,7 +66,8 @@ The output will look like this::
rhui-REGION-rhel-server-source-extras/7Server/x86_64 Red H disabled
rhui-REGION-rhel-server-source-optional/7Server/x86_64 Red H disabled
Use the names of the repositories (minus the version and architecture) to enable them::
Use the names of the repositories (minus the version and architecture)
to enable them::
sudo yum-config-manager --enable rhui-REGION-rhel-server-optional
sudo yum-config-manager --enable rhui-REGION-rhel-server-extras

View File

@ -58,8 +58,9 @@ need to be fixed by looking for any URLs in the
External Steps
^^^^^^^^^^^^^^
Bifrost doesn't attempt to configure ``apt``, ``yum``, or ``pip``, so if you are
working in an offline mode, you'll need to make sure those work independently.
Bifrost doesn't attempt to configure ``apt``, ``yum``, or ``pip``,
so if you are working in an offline mode, you'll need to make sure
those work independently.
``pip`` in particular will be sensitive; Bifrost tends to use the most recent
version of python modules, so you'll want to make sure your cache isn't stale.

View File

@ -89,8 +89,8 @@ Internet Systems Consortium DHCPd::
Architecture
------------
It should be emphasized that Ironic in standalone mode is intended to be used only
in a trusted environment.
It should be emphasized that Ironic in standalone mode is intended to be used
only in a trusted environment.
::

View File

@ -208,10 +208,11 @@ http://docs.ansible.com/ansible/intro_dynamic_inventory.html#using-inventory-dir
Note::
Before running the above command, ensure that the value for `ssh_public_key_path` in
``./playbooks/inventory/group_vars/baremetal`` refers to a valid public key file,
or set the ssh_public_key_path option on the ansible-playbook command line by
setting the variable. Example: "-e ssh_public_key_path=~/.ssh/id_rsa.pub"
Before running the above command, ensure that the value for
`ssh_public_key_path` in ``./playbooks/inventory/group_vars/baremetal``
refers to a valid public key file, or set the ssh_public_key_path option
on the ansible-playbook command line by setting the variable.
Example: "-e ssh_public_key_path=~/.ssh/id_rsa.pub"
If the hosts need to be re-deployed, the dynamic redeploy playbook may be used::

View File

@ -16,9 +16,9 @@ are being booted can connect to the following ports::
6301/TCP for the ironic API
8080/TCP for HTTP File Downloads (iPXE, Ironic-Python-Agent)
If you encounter any additional issues, use of ``tcpdump`` is highly recommended
while attempting to deploy a single node in order to capture and review the
traffic exchange between the two nodes.
If you encounter any additional issues, use of ``tcpdump`` is highly
recommended while attempting to deploy a single node in order to capture
and review the traffic exchange between the two nodes.
*****************
NodeLocked Errors
@ -211,6 +211,6 @@ or any other IPA image, you will need to take the following steps:
respectively.
#. Execute the installation playbook, and the set files will be automatically
downloaded again. If the files are not removed prior to (re)installation,
then they will not be replaced. Alternatively, the files can just be directly
replaced on disk. The default where the kernel and ramdisk are located is in
``/httboot/``.
then they will not be replaced. Alternatively, the files can just be
directly replaced on disk. The default where the kernel and ramdisk are
located is in ``/httboot/``.

View File

@ -5,6 +5,7 @@
hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
coverage!=4.4,>=4.0 # Apache-2.0
doc8>=0.6.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
sphinx>=1.6.2 # BSD
openstackdocstheme>=1.17.0 # Apache-2.0

View File

@ -15,6 +15,7 @@ commands = python setup.py test --slowest --testr-args='{posargs}'
[testenv:pep8]
commands = flake8
doc8 doc/source releasenotes/source README.rst CONTRIBUTING.rst MISSION.rst HACKING.rst --ignore D000
[testenv:venv]
commands = {posargs}