Fixing warnings to unclutter the build log

As part of cleaning up the Anuket/OPNFV documentation, this
change fixes a few warnings to unclutter the build log.

Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
Change-Id: I90351d55b2def457b2180cf20d96b9035b5802ff

diff --git a/docs/conf.py b/docs/conf.py
index e492d48..00d63dc 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -7,6 +7,12 @@ extensions = ['sphinx.ext.intersphinx',
               'sphinx.ext.autosectionlabel'
              ]
 html_theme = "sphinx_material"
+exclude_patterns = [
+    '**/.tox',
+    'templates',                     # suppress warning that these files are not included in any toctree
+    'how-to-use-docs/files',         # suppress warning that these files are not included in any toctree
+    'development/feature.templates'  # suppress warning that these files are not included in any toctree
+]
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

diff --git a/docs/development/opnfvsecguide/audit.rst b/docs/development/opnfvsecguide/audit.rst
index cdeecba..014f6c6 100644 (file)
--- a/docs/development/opnfvsecguide/audit.rst
+++ b/docs/development/opnfvsecguide/audit.rst
@@ -5,5 +5,3 @@ Audit
    :maxdepth: 2
 
    audit/audit_reqs
-   audit/configuring
-

diff --git a/docs/development/opnfvsecguide/audit/audit_reqs.rst b/docs/development/opnfvsecguide/audit/audit_reqs.rst
index ce76d01..7923e51 100644 (file)
--- a/docs/development/opnfvsecguide/audit/audit_reqs.rst
+++ b/docs/development/opnfvsecguide/audit/audit_reqs.rst
@@ -15,6 +15,7 @@ http://www.etsi.org/deliver/etsi_gs/NFV-INF/001_099/004/01.01.01_60/gs_NFV-INF00
 
 
 .. _NFV-SEC-003: http://www.etsi.org/deliver/etsi_gs/NFV-SEC/001_099/003/01.01.01_60/gs_NFV-SEC003v010101p.pdf
+
 * ETSI GS NFV 004 V1.1.1 (2013-10)
 
   - Network Functions Virtualisation (NFV);

diff --git a/docs/index.rst b/docs/index.rst
index 2bd47cb..aaba39e 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -60,7 +60,10 @@ Developer Guide
 Glossary
 --------
 
-:doc:`glossary/index`
+.. toctree::
+   :maxdepth: 1
+
+   glossary/index
 
 Found a typo or any other feedback? Send us an email_ or
 talk to us on Slack_.

diff --git a/docs/testing/ecosystem/energy-monitoring.rst b/docs/testing/ecosystem/energy-monitoring.rst
index 0c2cd35..b47f044 100644 (file)
--- a/docs/testing/ecosystem/energy-monitoring.rst
+++ b/docs/testing/ecosystem/energy-monitoring.rst
@@ -7,8 +7,8 @@
 Power Consumption Monitoring Framework
 ======================================
 
-Introduction
-------------
+Overview
+--------
 Power consumption is a key driver for NFV.
 As an end user is interested to know which application is good or bad regarding
 power consumption and explains why he/she has to plug his/her smartphone every
@@ -111,8 +111,8 @@ the "NODE_NAME" environment variable by CI when running.
 **IMPORTANT NOTE**: To apply a new configuration, you need to kill the running
 container an start a new one (see below)
 
-Run
-^^^
+Run Collector
+^^^^^^^^^^^^^
 
 To run the container, you have to map folder located on the host to folders in
 the container (config, logs)::
@@ -171,8 +171,8 @@ influx (see run-container.sh bellow). Use here the admin user.
 **IMPORTANT NOTE**: To apply a new configuration, you need to kill the running
 container an start a new one (see bellow)
 
-Run
-^^^
+Run API
+^^^^^^^
 To run the container, you have to map folder located on the host to folders in
 the container (config, logs)::
 

diff --git a/docs/testing/ecosystem/overview.rst b/docs/testing/ecosystem/overview.rst
index f92f567..309d626 100644 (file)
--- a/docs/testing/ecosystem/overview.rst
+++ b/docs/testing/ecosystem/overview.rst
@@ -1,3 +1,5 @@
+.. _testing_overview:
+
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. SPDX-License-Identifier: CC-BY-4.0