Use Sphinx 1.5 warning-is-error

With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Migrate
the setting from the old warnerrors one.

Fix problems found:
* Duplicate labels (rename wrong faq entries, rename unused drivers
  entries)
* Add api/autoindex.rst as hidden to the index so that we do not get a
  warning. The modindex includes the same content, so no need to show
  this.
* Add releasenotes/index.rst, webapi/v1.rst, user-guide, and install-guide.rst
  to hidden index since they're not listed in index on purpose, so sphinx
  will not warn that they do not appear in a toc
* Add deploy/radosgw to index
* ignore app.add_directiv warning
* Fix reference to user-guide to use proper markup so that Sphinx knows
  the user-guide is referenced.

Change-Id: I00d249229d4d31ba36d4393d60847fdb1513a744
This commit is contained in:
Andreas Jaeger 2017-03-04 19:11:26 +01:00
parent 2751ab9b81
commit 4cff2ab6d5
7 changed files with 23 additions and 8 deletions

View File

@ -79,6 +79,11 @@ for module in MOCK_MODULES:
# source directory, using slashes as directory separators on all platforms. # source directory, using slashes as directory separators on all platforms.
exclude_patterns = ['api/ironic_tempest_plugin.*'] exclude_patterns = ['api/ironic_tempest_plugin.*']
# Ignore the following warning: WARNING: while setting up extension
# wsmeext.sphinxext: directive 'autoattribute' is already registered,
# it will be overridden.
suppress_warnings = [ 'app.add_directive']
# -- Options for HTML output -------------------------------------------------- # -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with # The theme to use for HTML and HTML Help pages. Major themes that come with

View File

@ -1,4 +1,4 @@
.. _drivers: .. _enabling_drivers:
================ ================
Enabling drivers Enabling drivers

View File

@ -1,4 +1,4 @@
.. _drivers: .. _pluggable_drivers:
================= =================
Pluggable Drivers Pluggable Drivers

View File

@ -1,5 +1,3 @@
.. _faq:
=========================== ===========================
Ironic Governance Structure Ironic Governance Structure
=========================== ===========================

View File

@ -1,5 +1,3 @@
.. _faq:
========================= =========================
Releasing Ironic Projects Releasing Ironic Projects
========================= =========================

View File

@ -16,7 +16,7 @@ with a unified interface to a heterogeneous fleet of servers while also
providing the Compute service with an interface that allows physical servers to providing the Compute service with an interface that allows physical servers to
be managed as though they were virtual machines. be managed as though they were virtual machines.
`An introduction to ironic's conceptual architecture <deploy/user-guide.html>`_ :doc:`An introduction to ironic's conceptual architecture <deploy/user-guide>`
is available for those new to the project. is available for those new to the project.
Site Notes Site Notes
@ -166,6 +166,7 @@ of ironic that may or may not be suitable to every situation.
Emitting software metrics <deploy/metrics> Emitting software metrics <deploy/metrics>
Auditing API Traffic <deploy/api-audit-support> Auditing API Traffic <deploy/api-audit-support>
Notifications <deploy/notifications> Notifications <deploy/notifications>
Ceph Object Gateway support <deploy/radosgw>
Configuration Reference <http://docs.openstack.org/draft/config-reference/bare-metal.html> Configuration Reference <http://docs.openstack.org/draft/config-reference/bare-metal.html>
Sample configuration file <https://git.openstack.org/cgit/openstack/ironic/tree/etc/ironic/ironic.conf.sample> Sample configuration file <https://git.openstack.org/cgit/openstack/ironic/tree/etc/ironic/ironic.conf.sample>
@ -210,3 +211,16 @@ Indices and tables
* :ref:`genindex` * :ref:`genindex`
* :ref:`modindex` * :ref:`modindex`
* :ref:`search` * :ref:`search`
.. # NOTE(jaegerandi): This is where we hide things that we don't want
# shown in the top level table of contents. api/autoindex is hidden
# since it's in the modindex link above.
# deploy/user-guide is referenced above but not in a toctree.
.. toctree::
:hidden:
api/autoindex
deploy/install-guide.rst
deploy/user-guide.rst
releasenotes/index
webapi/v1.rst

View File

@ -153,12 +153,12 @@ autodoc_exclude_modules =
ironic.db.sqlalchemy.alembic.env ironic.db.sqlalchemy.alembic.env
ironic.db.sqlalchemy.alembic.versions.* ironic.db.sqlalchemy.alembic.versions.*
ironic_tempest_plugin.* ironic_tempest_plugin.*
warnerrors = True
[build_sphinx] [build_sphinx]
all_files = 1 all_files = 1
build-dir = doc/build build-dir = doc/build
source-dir = doc/source source-dir = doc/source
warning-is-error = 1
[egg_info] [egg_info]
tag_build = tag_build =