From 2b422dbad1316d66346e4c6d790eec4e525eb025 Mon Sep 17 00:00:00 2001 From: Chris Smart Date: Mon, 25 Jul 2016 22:09:08 +1000 Subject: [PATCH] [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 --- .../install-guide-revised-draft/app-configfiles.rst | 4 ++-- .../app-custom-layouts.rst | 4 ++-- .../overview-storage-arch.rst | 11 +++++++---- doc/source/install-guide-revised-draft/overview.rst | 4 ++-- doc/source/install-guide/app-configfiles.rst | 4 ++-- doc/source/install-guide/overview.rst | 4 ++-- tox.ini | 1 + 7 files changed, 18 insertions(+), 14 deletions(-) diff --git a/doc/source/install-guide-revised-draft/app-configfiles.rst b/doc/source/install-guide-revised-draft/app-configfiles.rst index b8901158e6..9062d3efdd 100644 --- a/doc/source/install-guide-revised-draft/app-configfiles.rst +++ b/doc/source/install-guide-revised-draft/app-configfiles.rst @@ -1,8 +1,8 @@ `Home `_ OpenStack-Ansible Installation Guide -================================ +================================= Appendix A: Configuration files -================================ +================================= `openstack_user_config.yml `_ diff --git a/doc/source/install-guide-revised-draft/app-custom-layouts.rst b/doc/source/install-guide-revised-draft/app-custom-layouts.rst index 7b45dfe479..c727116b17 100644 --- a/doc/source/install-guide-revised-draft/app-custom-layouts.rst +++ b/doc/source/install-guide-revised-draft/app-custom-layouts.rst @@ -1,8 +1,8 @@ `Home `_ OpenStack-Ansible Installation Guide -================================================= +================================================== Appendix E: Customizing host and service layouts -================================================= +================================================== Understanding the default layout ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/install-guide-revised-draft/overview-storage-arch.rst b/doc/source/install-guide-revised-draft/overview-storage-arch.rst index ff8c2ce38d..5dcf0818fc 100644 --- a/doc/source/install-guide-revised-draft/overview-storage-arch.rst +++ b/doc/source/install-guide-revised-draft/overview-storage-arch.rst @@ -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: ``_. 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) ------------------------------------- diff --git a/doc/source/install-guide-revised-draft/overview.rst b/doc/source/install-guide-revised-draft/overview.rst index 898bc2b422..f7000ce664 100644 --- a/doc/source/install-guide-revised-draft/overview.rst +++ b/doc/source/install-guide-revised-draft/overview.rst @@ -1,8 +1,8 @@ `Home `_ OpenStack-Ansible Installation Guide -==================== +===================== Chapter 1. Overview -==================== +===================== .. toctree:: diff --git a/doc/source/install-guide/app-configfiles.rst b/doc/source/install-guide/app-configfiles.rst index b8901158e6..9062d3efdd 100644 --- a/doc/source/install-guide/app-configfiles.rst +++ b/doc/source/install-guide/app-configfiles.rst @@ -1,8 +1,8 @@ `Home `_ OpenStack-Ansible Installation Guide -================================ +================================= Appendix A: Configuration files -================================ +================================= `openstack_user_config.yml `_ diff --git a/doc/source/install-guide/overview.rst b/doc/source/install-guide/overview.rst index a926e14290..3cc299b65f 100644 --- a/doc/source/install-guide/overview.rst +++ b/doc/source/install-guide/overview.rst @@ -1,8 +1,8 @@ `Home `_ OpenStack-Ansible Installation Guide -==================== +===================== Chapter 1. Overview -==================== +===================== .. toctree:: diff --git a/tox.ini b/tox.ini index 72457ea4a4..0d87844d63 100644 --- a/tox.ini +++ b/tox.ini @@ -173,6 +173,7 @@ commands = {[testenv:ansible-lint]commands} {[testenv:ansible-syntax]commands} {[testenv:inventory]commands} + {[testenv:docs]commands} [testenv:functional]