From 06bc48c0fdaff03036e0854c0583ae6bd8d3d683 Mon Sep 17 00:00:00 2001
From: Thanh Ha <thanh.ha@linuxfoundation.org>
Date: Wed, 17 Jan 2018 22:25:14 -0500
Subject: [PATCH] Fix view definition documentation

View documentation was not properly being generated and linked
in the index. Let's add that in.

Change-Id: I6197dbecc89ddcf8c6f6b0e6a3d4c517224dc77b
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
---
 doc/source/definition.rst             |  1 +
 doc/source/view_pipeline.rst          |  7 +++++++
 jenkins_jobs/modules/view_list.py     | 21 ++++++++++++++++-----
 jenkins_jobs/modules/view_pipeline.py | 14 +++++++-------
 4 files changed, 31 insertions(+), 12 deletions(-)
 create mode 100644 doc/source/view_pipeline.rst

diff --git a/doc/source/definition.rst b/doc/source/definition.rst
index b9315b89e..13c44fda8 100644
--- a/doc/source/definition.rst
+++ b/doc/source/definition.rst
@@ -518,6 +518,7 @@ The bulk of the job definitions come from the following modules.
    :glob:
 
    project_*
+   view_*
    builders
    hipchat
    metadata
diff --git a/doc/source/view_pipeline.rst b/doc/source/view_pipeline.rst
new file mode 100644
index 000000000..eeb8d7764
--- /dev/null
+++ b/doc/source/view_pipeline.rst
@@ -0,0 +1,7 @@
+.. view_pipeline:
+
+Pipeline View
+=============
+
+.. automodule:: view_pipeline
+   :members:
diff --git a/jenkins_jobs/modules/view_list.py b/jenkins_jobs/modules/view_list.py
index c4ab81dee..098e53627 100644
--- a/jenkins_jobs/modules/view_list.py
+++ b/jenkins_jobs/modules/view_list.py
@@ -12,11 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import xml.etree.ElementTree as XML
-import jenkins_jobs.modules.base
-
-from jenkins_jobs.modules.helpers import convert_mapping_to_xml
-
 """
 The view list module handles creating Jenkins List views.
 
@@ -38,8 +33,24 @@ to the :ref:`View-list` definition.
     * **recurse** (`bool`): Recurse in subfolders.(default false)
     * **status-filter** (`bool`): Filter job list by enabled/disabled
       status. (optional)
+
+Example:
+
+    .. literalinclude::
+        /../../tests/views/fixtures/view_list001.yaml
+
+Example:
+
+    .. literalinclude::
+        /../../tests/views/fixtures/view_list002.yaml
 """
 
+import xml.etree.ElementTree as XML
+import jenkins_jobs.modules.base
+
+from jenkins_jobs.modules.helpers import convert_mapping_to_xml
+
+
 COLUMN_DICT = {
     'status': 'hudson.views.StatusColumn',
     'weather': 'hudson.views.WeatherColumn',
diff --git a/jenkins_jobs/modules/view_pipeline.py b/jenkins_jobs/modules/view_pipeline.py
index c25a3cd75..5f49ea0f2 100644
--- a/jenkins_jobs/modules/view_pipeline.py
+++ b/jenkins_jobs/modules/view_pipeline.py
@@ -12,11 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import xml.etree.ElementTree as XML
-import jenkins_jobs.modules.base
-
-from jenkins_jobs.modules.helpers import convert_mapping_to_xml
-
 """
 The view pipeline module handles creating Jenkins Build Pipeline views.
 To create a list view specify ``list`` in the ``view-type`` attribute
@@ -57,14 +52,19 @@ Requires the Jenkins
 Example:
 
     .. literalinclude::
-        /../../tests/views/fixtures/pipeline_view001.yaml
+        /../../tests/views/fixtures/view_pipeline001.yaml
 
 Example:
 
     .. literalinclude::
-        /../../tests/views/fixtures/pipeline_view002.yaml
+        /../../tests/views/fixtures/view_pipeline002.yaml
 """
 
+import xml.etree.ElementTree as XML
+import jenkins_jobs.modules.base
+
+from jenkins_jobs.modules.helpers import convert_mapping_to_xml
+
 
 class Pipeline(jenkins_jobs.modules.base.Base):
     sequence = 0