From abd4d6473140bc864071d823fcf2d58bd619cac7 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Tue, 28 Aug 2018 08:48:48 +0200 Subject: [PATCH] Fix doc8 failure doc8 is now run as part of the new docs build job, fix failure. Merge duplicated section. Remove html_static_path, this is non-existant. Fix docs environment to enable warnings. Change-Id: I47b0af6257c0bc96fd23a5bd8620a6e137c77f17 --- README.rst | 37 +++++++++++++++------------------- doc/source/conf.py | 2 +- doc/source/configure-trove.rst | 15 +++++++------- tox.ini | 2 +- 4 files changed, 26 insertions(+), 30 deletions(-) diff --git a/README.rst b/README.rst index 4f4926f..b869f96 100644 --- a/README.rst +++ b/README.rst @@ -7,12 +7,26 @@ Team and repository tags .. Change things from this point on -OpenStack-Ansible Trove (DBaaS) -############################### +======================= +OpenStack-Ansible Trove +======================= Ansible role that installs and configures OpenStack Trove. Trove is installed behind the Apache webserver listening on port 8779 by default. +Documentation for the project can be found at: +``_ + +Release notes for the project can be found at: +``_ + +The project source code repository is located at: +``_ + +The project home is at: +``_ + + Required Variables ================== @@ -37,22 +51,3 @@ Example Playbook vars: is_metal: "{{ properties.is_metal|default(false) }}" -.. Change things from this point on - -========================= -OpenStack-Ansible Trove -========================= - -Ansible role that installs and configures OpenStack Trove. - -Documentation for the project can be found at: -``_ - -Release notes for the project can be found at: -``_ - -The project source code repository is located at: -``_ - -The project home is at: -``_ diff --git a/doc/source/conf.py b/doc/source/conf.py index 26083fc..7b9e38c 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -167,7 +167,7 @@ html_theme = 'openstackdocs' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +# html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied diff --git a/doc/source/configure-trove.rst b/doc/source/configure-trove.rst index ecddcde..cb04634 100644 --- a/doc/source/configure-trove.rst +++ b/doc/source/configure-trove.rst @@ -8,13 +8,14 @@ Configuring Trove Be sure to fully understand the security implications of the deployed architecture. -Trove provides DBaaS to an OpenStack deployment. It deploys guest VMs that -provide the desired DB for use by the end consumer. The trove guest VMs need -connectivity back to the trove services via RPC (oslo.messaging) and the -OpenStack services. The way these guest VM get access to those services could be -via internal networking (in the case of oslo.messaging) or via public interfaces -(in the case of OpenStack services). For the example configuration, we'll -designate a provider network as the network for trove to provision on each guest +Trove provides DBaaS to an OpenStack deployment. It deploys guest VMs +that provide the desired DB for use by the end consumer. The trove +guest VMs need connectivity back to the trove services via RPC +(oslo.messaging) and the OpenStack services. The way these guest VM +get access to those services could be via internal networking (in the +case of oslo.messaging) or via public interfaces (in the case of +OpenStack services). For the example configuration, we'll designate a +provider network as the network for trove to provision on each guest VM. The guest can then connect to oslo.messaging via this network and to the OpenStack services externally. Optionally, the guest VMs could use the internal network to access OpenStack services, but that would require more containers diff --git a/tox.ini b/tox.ini index 878b236..0ed5b9c 100644 --- a/tox.ini +++ b/tox.ini @@ -37,7 +37,7 @@ deps = -r{toxinidir}/doc/requirements.txt commands= bash -c "rm -rf doc/build" doc8 doc - sphinx-build -b html doc/source doc/build/html + sphinx-build -W -E -b html doc/source doc/build/html [doc8]