From 63ed6aaecdfca33b44ac378860abddccea3ebd48 Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Wed, 23 Sep 2015 12:35:40 +0900 Subject: [PATCH] Fix the broken link in devref docs The link to Dashboard is broken in the generated docuemnt http://docs.openstack.org/developer/neutron/ This patch fixes it and addresses warnings so that tox -e docs works. Also add a reference to Gerrit Dashboard Creator so that developers can customize it to what they want. Change-Id: Ic45ab48e68af9e5e8255161fe9eb2354ae124f50 --- doc/source/dashboards/check.dashboard.rst | 6 ++++-- doc/source/dashboards/gate.dashboard.rst | 6 ++++-- doc/source/dashboards/index.rst | 13 +++++++++---- doc/source/index.rst | 10 +++++----- 4 files changed, 22 insertions(+), 13 deletions(-) diff --git a/doc/source/dashboards/check.dashboard.rst b/doc/source/dashboards/check.dashboard.rst index 41364979d..71dd3ce12 100644 --- a/doc/source/dashboards/check.dashboard.rst +++ b/doc/source/dashboards/check.dashboard.rst @@ -1,6 +1,8 @@ -Neutron Check Pipeline Thumbnails - Click to see full size figure -================================================================= +Neutron Check Pipeline Thumbnails +================================= + +Click to see full size figure. .. raw:: html diff --git a/doc/source/dashboards/gate.dashboard.rst b/doc/source/dashboards/gate.dashboard.rst index 206735acd..94fbbe9df 100644 --- a/doc/source/dashboards/gate.dashboard.rst +++ b/doc/source/dashboards/gate.dashboard.rst @@ -1,6 +1,8 @@ -Neutron Graphite Thumbnails - Click to see full size figure -=========================================================== +Neutron Graphite Thumbnails +=========================== + +Click to see full size figure. .. raw:: html diff --git a/doc/source/dashboards/index.rst b/doc/source/dashboards/index.rst index bfef85742..85de81daf 100644 --- a/doc/source/dashboards/index.rst +++ b/doc/source/dashboards/index.rst @@ -5,11 +5,16 @@ Gerrit Dashboards - `Neutron subproject reviews (master branch) `_ - `Neutron stable branch reviews `_ +These dashboard links can be generated by `Gerrit Dashboard Creator`_. +Useful dashboard definitions are found in ``dashboards`` directory. + +.. _Gerrit Dashboard Creator: https://github.com/stackforge/gerrit-dash-creator + Neutron Graphite Pages ====================== -- `Graphs of gate job failures`_ -- `Graphs of check job failures`_ +.. toctree:: + :maxdepth: 1 -.. _`Graphs of gate job failures`: gate.dashboard -.. _`Graphs of check job failures`: check.dashboard + gate.dashboard + check.dashboard diff --git a/doc/source/index.rst b/doc/source/index.rst index 84d3171fb..bed4d897f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -58,13 +58,13 @@ Developer Docs Dashboards ========== -.. toctree:: - :maxdepth: 1 - There is a collection of dashboards to help developers and reviewers -located here_ +located here. + +.. toctree:: + :maxdepth: 2 -.. _here: dashboards/index + dashboards/index API Extensions ============== -- 2.45.2