diff --git a/doc/source/conf.py b/doc/source/conf.py index bfbff55560..9c28b3f331 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -79,6 +79,11 @@ for module in MOCK_MODULES: # source directory, using slashes as directory separators on all platforms. 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 -------------------------------------------------- # The theme to use for HTML and HTML Help pages. Major themes that come with diff --git a/doc/source/deploy/drivers.rst b/doc/source/deploy/drivers.rst index 56a286a6ce..4774a799ec 100644 --- a/doc/source/deploy/drivers.rst +++ b/doc/source/deploy/drivers.rst @@ -1,4 +1,4 @@ -.. _drivers: +.. _enabling_drivers: ================ Enabling drivers diff --git a/doc/source/dev/drivers.rst b/doc/source/dev/drivers.rst index d2f4aee412..d7a5e88a97 100644 --- a/doc/source/dev/drivers.rst +++ b/doc/source/dev/drivers.rst @@ -1,4 +1,4 @@ -.. _drivers: +.. _pluggable_drivers: ================= Pluggable Drivers diff --git a/doc/source/dev/governance.rst b/doc/source/dev/governance.rst index dffb877b17..a74d73cb05 100644 --- a/doc/source/dev/governance.rst +++ b/doc/source/dev/governance.rst @@ -1,5 +1,3 @@ -.. _faq: - =========================== Ironic Governance Structure =========================== diff --git a/doc/source/dev/releasing.rst b/doc/source/dev/releasing.rst index e504fb0fd6..54c14654a9 100644 --- a/doc/source/dev/releasing.rst +++ b/doc/source/dev/releasing.rst @@ -1,5 +1,3 @@ -.. _faq: - ========================= Releasing Ironic Projects ========================= diff --git a/doc/source/index.rst b/doc/source/index.rst index 87572fbb41..a4588b0349 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 be managed as though they were virtual machines. -`An introduction to ironic's conceptual architecture `_ +:doc:`An introduction to ironic's conceptual architecture ` is available for those new to the project. Site Notes @@ -166,6 +166,7 @@ of ironic that may or may not be suitable to every situation. Emitting software metrics Auditing API Traffic Notifications + Ceph Object Gateway support Configuration Reference Sample configuration file @@ -210,3 +211,16 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :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 diff --git a/setup.cfg b/setup.cfg index eba73c3535..587110225c 100644 --- a/setup.cfg +++ b/setup.cfg @@ -153,12 +153,12 @@ autodoc_exclude_modules = ironic.db.sqlalchemy.alembic.env ironic.db.sqlalchemy.alembic.versions.* ironic_tempest_plugin.* -warnerrors = True [build_sphinx] all_files = 1 build-dir = doc/build source-dir = doc/source +warning-is-error = 1 [egg_info] tag_build =