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
This commit is contained in:
Andreas Jaeger 2018-08-28 08:48:48 +02:00
parent 2b413bc815
commit abd4d64731
4 changed files with 26 additions and 30 deletions

View File

@ -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:
`<https://docs.openstack.org/openstack-ansible-os_trove/latest/>`_
Release notes for the project can be found at:
`<https://docs.openstack.org/releasenotes/openstack-ansible-os_trove/>`_
The project source code repository is located at:
`<https://git.openstack.org/cgit/openstack/openstack-ansible-os_trove>`_
The project home is at:
`<https://launchpad.net/openstack-ansible>`_
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:
`<https://docs.openstack.org/openstack-ansible-os_trove/latest/>`_
Release notes for the project can be found at:
`<https://docs.openstack.org/releasenotes/openstack-ansible-os_trove/>`_
The project source code repository is located at:
`<https://git.openstack.org/cgit/openstack/openstack-ansible-os_trove>`_
The project home is at:
`<https://launchpad.net/openstack-ansible>`_

View File

@ -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

View File

@ -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

View File

@ -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]