Enable warning-is-error for docs job

As of I319e0d4e4dd03b7f769d9d38ad2829d6cc9a679a, the warnings in the
tripleo-docs build should be fixed and it would be good to keep it
that way.

This was added in sphinx 1.5, which is now in global-requirements.
We should add a requirements sync job to this repo so we don't get
out of date again.

Note that since this was originally proposed, some new warnings
have been added to the repo.  These are also fixed in this commit.

Change-Id: Ibc673109878d5edc9a2772e7e0650a1ed31a6cc7
This commit is contained in:
Ben Nemec 2017-02-07 23:39:59 +00:00
parent 701430c690
commit 19e09e078a
5 changed files with 26 additions and 20 deletions

View File

@ -116,10 +116,9 @@ script is called from the `post.yaml` file and it takes a `json` file as
configuration.
The `docker-puppet.py` execution results in a oneshot container being executed
(usually named `puppet-$service_name) to generate the configuration options or
(usually named `puppet-$service_name`) to generate the configuration options or
run other service specific operations. Example: Create Keystone endpoints.
Anatomy of a containerized service template
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -243,19 +242,28 @@ containers steps. These steps are executed sequentially:
#. Containers config files generated per hiera settings.
#. Load Balancer configuration baremetal
#. Step 1 baremetal
#. Step 1 containers
#. Core Services (Database/Rabbit/NTP/etc.)
#. Step 2 baremetal
#. Step 2 containers
#. Early Openstack Service setup (Ringbuilder, etc.)
#. Step 3 baremetal
#. Step 3 containers
#. General OpenStack Services
#. Step 4 baremetal
#. Step 4 containers
#. Keystone containers post initialization (tenant, service, endpoint creation)
#. Service activation (Pacemaker)
#. Step 5 baremetal
#. Step 5 containers

View File

@ -166,5 +166,5 @@ second one is `heat-all` which executes the templates and installs the services.
The latter can be run on baremetal or in a container (tripleoclient will run it
in a container by default).
Checkout the `TripleO Containers Architecture`_ for more detailed info on how
Checkout the :doc:`architecture` for more detailed info on how
TripleO builds, creates and runs containers.

View File

@ -267,7 +267,7 @@ major-upgrade-composable-steps that comes first, as described above.
.. _manifests: https://github.com/openstack/tripleo-heat-templates/tree/master/puppet/services
Upgrading the Overcloud to Newton and earlier
-----------------------
---------------------------------------------
.. note::

View File

@ -22,6 +22,7 @@ classifier =
all_files = 1
build-dir = doc/build
source-dir = doc/source
warning-is-error = 1
[egg_info]
tag_build =
@ -30,6 +31,3 @@ tag_svn_revision = 0
[wheel]
universal = 1
[pbr]
warnerrors = False

View File

@ -1,6 +1,6 @@
# Doc requirements
sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
oslosphinx>=2.2.0 # Apache-2.0
sphinx>=1.5.1 # BSD
oslosphinx>=4.7.0 # Apache-2.0
sphinx_rtd_theme==0.1.7
hacking>=0.10.0,<0.11