diff options
| -rw-r--r-- | .gitignore | 3 | ||||
| -rw-r--r-- | baro_tests/collectd.py | 8 | ||||
| -rw-r--r-- | docs/conf.py | 1 | ||||
| -rw-r--r-- | docs/conf.yaml | 3 | ||||
| -rw-r--r-- | docs/release/configguide/postinstall.rst | 2 | ||||
| -rw-r--r-- | docs/release/userguide/collectd.ves.userguide.rst | 1 | ||||
| -rw-r--r-- | docs/release/userguide/docker.userguide.rst | 8 | ||||
| -rw-r--r-- | docs/requirements.txt | 2 | ||||
| -rw-r--r-- | tox.ini | 17 |
9 files changed, 35 insertions, 10 deletions
@@ -1,7 +1,6 @@ *~ *.sw? *.pyc -/docs_build/ /docs_output/ /releng/ *.egg-info/ @@ -9,3 +8,5 @@ .settings build dist +.tox +docs/_build/* diff --git a/baro_tests/collectd.py b/baro_tests/collectd.py index 51350495..4148c27a 100644 --- a/baro_tests/collectd.py +++ b/baro_tests/collectd.py @@ -794,15 +794,15 @@ def main(bt_logger=None): compute_node_names.append(node_name) plugins_to_enable = [] error_plugins = [] - gnocchi_running = ( + gnocchi_running_com = ( gnocchi_running and conf.check_gnocchi_plugin_included( compute_node)) - aodh_running = ( + aodh_running_com = ( aodh_running and conf.check_aodh_plugin_included(compute_node)) # logger.info("SNMP enabled on {}" .format(node_name)) - if gnocchi_running: + if gnocchi_running_com: out_plugins[node_id].append("Gnocchi") - if aodh_running: + if aodh_running_com: out_plugins[node_id].append("AODH") if snmp_running: out_plugins[node_id].append("SNMP") diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..3c4453e7 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1 @@ +from docs_conf.conf import * diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 00000000..cba650f1 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: BAROMETER diff --git a/docs/release/configguide/postinstall.rst b/docs/release/configguide/postinstall.rst index 8968e802..8f23eec3 100644 --- a/docs/release/configguide/postinstall.rst +++ b/docs/release/configguide/postinstall.rst @@ -168,4 +168,4 @@ dashboards such as ``CPU Usage`` and ``Host Overview``. For more details on the Barometer containers, Grafana and InfluxDB, please refer to the following documentation links: https://wiki.opnfv.org/display/fastpath/Barometer+Containers#BarometerContainers-barometer-collectdcontainer -http://docs.opnfv.org/en/latest/submodules/barometer/docs/release/userguide/docker.userguide.html#barometer-collectd-image +:ref:`<barometer-docker-userguide>` diff --git a/docs/release/userguide/collectd.ves.userguide.rst b/docs/release/userguide/collectd.ves.userguide.rst index 8b666114..29de46a3 100644 --- a/docs/release/userguide/collectd.ves.userguide.rst +++ b/docs/release/userguide/collectd.ves.userguide.rst @@ -1,6 +1,7 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. (c) OPNFV, Intel Corporation and others. +.. _barometer-ves-userguide: ========================== VES Application User Guide diff --git a/docs/release/userguide/docker.userguide.rst b/docs/release/userguide/docker.userguide.rst index f5291ce1..258d122d 100644 --- a/docs/release/userguide/docker.userguide.rst +++ b/docs/release/userguide/docker.userguide.rst @@ -1,6 +1,7 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. (c) <optionally add copywriters name> +.. _barometer-docker-userguide: =================================== OPNFV Barometer Docker User Guide @@ -28,8 +29,7 @@ For steps to build and run InfluxDB and Grafana images please see section `Build For steps to build and run VES and Kafka images please see section `Build and Run VES and Kafka Docker Images`_ -For overview of running VES application with Kafka please see the `VES Application User Guide -<http://docs.opnfv.org/en/latest/submodules/barometer/docs/release/userguide/collectd.ves.userguide.html>`_ +For overview of running VES application with Kafka please see the :ref:`VES Application User Guide <barometer-ves-userguide>` Barometer Docker Images Description ----------------------------------- @@ -91,8 +91,8 @@ The Barometer project's VES application and Kafka docker images are based on a C docker image has a dependancy on `Zookeeper <https://zookeeper.apache.org/>`_. Kafka must be able to connect and register with an instance of Zookeeper that is either running on local or remote host. Kafka recieves and stores metrics recieved from Collectd. VES application pulls latest metrics from Kafka -which it normalizes into VES format for sending to a VES collector. Please see details in `VES Application User Guide -<http://docs.opnfv.org/en/latest/submodules/barometer/docs/release/userguide/collectd.ves.userguide.html>`_ +which it normalizes into VES format for sending to a VES collector. Please see details in +:ref:`VES Application User Guide <barometer-ves-userguide>` Download and Run Docker Images with Ansible-Playbook ---------------------------------------------------- diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..9fde2df2 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +lfdocs-conf +sphinx_opnfv_theme diff --git a/tox.ini b/tox.ini new file mode 100644 index 00000000..69aa1893 --- /dev/null +++ b/tox.ini @@ -0,0 +1,17 @@ +[tox] +minversion = 1.6 +envlist = + docs, + docs-linkcheck +skipsdist = true + +[testenv:docs] +deps = -rdocs/requirements.txt +commands = + sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + echo "Generated docs available in {toxinidir}/docs/_build/html" +whitelist_externals = echo + +[testenv:docs-linkcheck] +deps = -rdocs/requirements.txt +commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck |