openstack
/
openstack-ansible
Code Issues Proposed changes

[DOCS] Fix up validation failures 

Attempting to build the documentation with "tox -e docs" results in a
failure due to several lint errors. This patch fixes those errors so
that the docs build successfully.

The 'docs' target is also added to the 'linters' target chain so that
the doc8 linting is executed as part of the lint checks to ensure that
these issues don't re-occur.

Change-Id: I9e1bf2cabe9a0591963d1afadbeb24cb614e0b27
This commit is contained in:
Chris Smart 2016-07-25 22:09:08 +10:00 committed by Jesse Pretorius
parent e3afd5b3e4
commit 2b422dbad1
7 changed files with 18 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/install-guide-revised-draft/app-configfiles.rst
View File

@ -1,8 +1,8 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide
================================
=================================
Appendix A: Configuration files
================================
=================================
`openstack_user_config.yml
<https://raw.githubusercontent.com/openstack/openstack-ansible/master/etc/openstack_deploy/openstack_user_config.yml.example>`_

4
doc/source/install-guide-revised-draft/app-custom-layouts.rst
View File

@ -1,8 +1,8 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide
=================================================
==================================================
Appendix E: Customizing host and service layouts
=================================================
==================================================
Understanding the default layout
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

11
doc/source/install-guide-revised-draft/overview-storage-arch.rst
View File

@ -10,7 +10,8 @@ OpenStack Ansible supports Block Storage (cinder) and Object Storage (swift).
Block storage (cinder)
~~~~~~~~~~~~~~~~~~~~~~
.. Suggestion: Document the location of the cinder-api service (containers on the infra hosts)
.. Suggestion: Document the location of the cinder-api service (containers on
the infra hosts)
.. Suggestion: Document the location of the cinder-volumes service
.. important::
@ -28,7 +29,7 @@ set up a container inside one of the infra hosts.
``cinder_volumes`` do not run in HA `active/active` mode.
This is not to be set up on multiple hosts. If you have multiple storage
backends, set up one per volumes container.
For more information: `https://specs.openstack.org/openstack/cinder-specs/specs/mitaka/cinder-volume-active-active-support.html>`_.
For more information: `<https://specs.openstack.org/openstack/cinder-specs/specs/mitaka/cinder-volume-active-active-support.html>`_.
Networking for Block Storage (cinder)
@ -42,8 +43,10 @@ and ``br-mgmt`` for API requests. ``cinder-volumes`` hosts require
Object Storage (swift)
~~~~~~~~~~~~~~~~~~~~~~
.. Suggestion: Document the location of the swift-proxy hosts (containers on the infra hosts).
.. Suggestion: Document the location of the swift account/object/container services (on separate physical hosts)
.. Suggestion: Document the location of the swift-proxy hosts (containers on
the infra hosts).
.. Suggestion: Document the location of the swift account/object/container
services (on separate physical hosts)
Networking for Object Storage (swift)
-------------------------------------

4
doc/source/install-guide-revised-draft/overview.rst
View File

@ -1,8 +1,8 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide
====================
=====================
Chapter 1. Overview
====================
=====================
.. toctree::

4
doc/source/install-guide/app-configfiles.rst
View File

@ -1,8 +1,8 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide
================================
=================================
Appendix A: Configuration files
================================
=================================
`openstack_user_config.yml
<https://raw.githubusercontent.com/openstack/openstack-ansible/master/etc/openstack_deploy/openstack_user_config.yml.example>`_

4
doc/source/install-guide/overview.rst
View File

@ -1,8 +1,8 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide
====================
=====================
Chapter 1. Overview
====================
=====================
.. toctree::

1
tox.ini
View File

@ -173,6 +173,7 @@ commands =
{[testenv:ansible-lint]commands}
{[testenv:ansible-syntax]commands}
{[testenv:inventory]commands}
{[testenv:docs]commands}
[testenv:functional]