ansible-collections
diff --git a/‎docs/Makefile‎
Lines changed: 10 additions & 2 deletions b/‎docs/Makefile‎
Lines changed: 10 additions & 2 deletions
diff --git a/‎docs/ansible_content.rst‎
Lines changed: 32 additions & 0 deletions b/‎docs/ansible_content.rst‎
Lines changed: 32 additions & 0 deletions
diff --git a/‎docs/scripts/auto-doc-gen.sh‎
Lines changed: 85 additions & 0 deletions b/‎docs/scripts/auto-doc-gen.sh‎
Lines changed: 85 additions & 0 deletions
diff --git a/‎docs/scripts/post-doc-gen.sh‎
Lines changed: 40 additions & 0 deletions b/‎docs/scripts/post-doc-gen.sh‎
Lines changed: 40 additions & 0 deletions
diff --git a/‎docs/scripts/pre-doc-gen.sh‎
Lines changed: 110 additions & 0 deletions b/‎docs/scripts/pre-doc-gen.sh‎
Lines changed: 110 additions & 0 deletions
diff --git a/‎docs/source/community_guides.rst‎
Lines changed: 2 additions & 12 deletions b/‎docs/source/community_guides.rst‎
Lines changed: 2 additions & 12 deletions
diff --git a/‎docs/source/conf.py‎
Lines changed: 11 additions & 3 deletions b/‎docs/source/conf.py‎
Lines changed: 11 additions & 3 deletions
@@ -10,8 +10,10 @@ SOURCEDIR     = source
 BUILDDIR      = build
 ROOT_DIR:=$(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
 
+
 view-html:
-	open build/html/index.html
+	@echo "Display generated HTML in default browser."
+	@open build/html/index.html
 
 # Put it first so that "make" without argument is like "make help".
 help:
@@ -73,11 +75,17 @@ module-doc:
 
 	@echo "Completed restructured text generation, run 'make html'"
 
+pre:
+	@$(shell scripts/auto-doc-gen.sh)
+	@echo "Completed auto-doc-generation see script auto-doc-gen.sh for details"
+
 html:
+
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-	@echo "Completed HTML generation, run 'make view-html'"
+	@echo "Completed HTML generation"
 
 html-all:
+
 	# @sphinx-versioning -l "$(ROOT_DIR)"/source/conf.py build  "$(ROOT_DIR)"/source/ "$(ROOT_DIR)"/build/html -- -D html_show_sphinx=False
 	@sphinx-versioning -l "$(ROOT_DIR)"/source/conf.py build  "$(ROOT_DIR)"/source/ "$(ROOT_DIR)"/build/html
 	@echo "Completed HTML generation for git repository branches and/or tags, run 'make view-html'"
 
@@ -0,0 +1,32 @@
+.. ...........................................................................
+.. © Copyright IBM Corporation 2020                                          .
+.. ...........................................................................
+
+=========
+z/OS Core
+=========
+
+The **IBM z/OS core collection**, also represented as **ibm\_zos\_core**
+in this document, is part of the broader offering **Red Hat® Ansible
+Certified Content for IBM Z**. IBM z/OS core collection supports tasks
+such as creating data sets, submitting jobs, querying jobs,
+retrieving job output, encoding data sets, fetching data sets, operator
+commands, TSO commands, ping and querying operator actions.
+
+The **IBM z/OS core collection** serves as a dependency for other collections
+under the **Red Hat® Ansible Certified Content for IBM Z** umbrella and
+works closely with offerings such as `IBM z/OS IMS collection`_ to deliver
+a solution that will enable you to automate tasks on z/OS subsystems such
+as IMS.
+
+.. _IBM z/OS IMS collection:
+   https://github.com/ansible-collections/ibm_zos_ims
+
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Reference
+
+   source/plugins
+   source/modules
+   source/filters
@@ -0,0 +1,85 @@
+#!/bin/sh
+
+################################################################################
+# © Copyright IBM Corporation 2020
+################################################################################
+
+################################################################################
+# Script and actions called before generating doc, helpful in cases where
+# customization is needed but does not apply to all collections
+################################################################################
+SCRIPT_PATH=`dirname "$0"`
+DOC_DIR=`( cd "$SCRIPT_PATH" && pwd )| sed 's|\(.*\)/.*|\1|'`
+# `pwd| sed 's|\(.*\)/.*|\1|'`
+
+################################################################################
+# Source the playbook*.rst into a single RST so that our topic is a single html
+################################################################################
+
+# If playbooks-single.rst exists, zero it out so we generate the lastest based
+# on the payboook-*.rst files
+if [[ -f $DOC_DIR/source/playbooks-single.rst  ]]; then
+    :> $DOC_DIR/source/playbooks-single.rst
+fi
+
+# Remove the first toctree entry and onwards from playbooks.rst to create a new
+# RST playbooks-single.rst. Note, you should ensure toctree entries are at the
+# end of the conent to not remove unwanted content.
+if [[ -f $DOC_DIR/source/playbooks.rst ]]; then
+
+    # Remove the toctree entries
+    awk '/toctree/ {exit} {print}' $DOC_DIR/source/playbooks.rst >> $DOC_DIR/source/playbooks-single.rst
+
+    # Concat the interested RSTs into playbooks-single.rst to create a single RST
+    if [[ -f $DOC_DIR/source/playbook_config_setup.rst && -f $DOC_DIR/source/playbook_inventory.rst && -f $DOC_DIR/source/playbook_group_vars.rst && -f $DOC_DIR/source/playbook_run.rst ]]; then
+
+        # Inform readers this is auto generated thus avoding the need to maintain
+        echo ".. ...........................................................................\n$(<$DOC_DIR/source/playbooks-single.rst)" > $DOC_DIR/source/playbooks-single.rst
+        echo ".. Auto generated restructured text                                          .\n$(<$DOC_DIR/source/playbooks-single.rst)" > $DOC_DIR/source/playbooks-single.rst
+        echo ".. ...........................................................................\n$(<$DOC_DIR/source/playbooks-single.rst)" > $DOC_DIR/source/playbooks-single.rst
+
+        # For each identified file we want to merge into playbooks-single.rst cat them and merge
+        for file in $DOC_DIR/source/playbook_config_setup.rst $DOC_DIR/source/playbook_inventory.rst $DOC_DIR/source/playbook_group_vars.rst $DOC_DIR/source/playbook_run.rst; do
+            echo "" >> $DOC_DIR/source/playbooks-single.rst;
+            cat "$file" >> $DOC_DIR/source/playbooks-single.rst;
+        done
+    else
+        # When unable to merge remove the auto generated RST so that is apparent
+        # it is not generated and will diff in a 'git status'
+
+        rm -rf $DOC_DIR/source/playbooks-single.rst
+    fi
+fi
+
+# If requirements-single.rst exists, zero it out so we generate the lastest based
+# on the requirements-*.rst files
+if [[ -f $DOC_DIR/source/requirements-single.rst  ]]; then
+    :> $DOC_DIR/source/requirements-single.rst
+fi
+
+# Remove the first toctree entry and onwards from playbooks.rst to create a new
+# RST requirements-single.rst. Note, you should ensure toctree entries are at
+# the end of the conent to not remove unwanted content.
+if [[ -f $DOC_DIR/source/requirements.rst ]]; then
+
+    # Remove the toctree entries
+    awk '/toctree/ {exit} {print}' $DOC_DIR/source/requirements.rst >> $DOC_DIR/source/requirements-single.rst
+
+    # Concat the interested RSTs into requirements-single.rst to create a single RST
+    if [[ -f $DOC_DIR/source/requirements_managed.rst ]]; then
+
+        # Inform readers this is auto generated thus avoding the need to maintain
+        echo ".. ...........................................................................\n$(<$DOC_DIR/source/requirements-single.rst)" > $DOC_DIR/source/requirements-single.rst
+        echo ".. Auto generated restructured text                                          .\n$(<$DOC_DIR/source/requirements-single.rst)" > $DOC_DIR/source/requirements-single.rst
+        echo ".. ...........................................................................\n$(<$DOC_DIR/source/requirements-single.rst)" > $DOC_DIR/source/requirements-single.rst
+
+        # For each identified file we want to merge into requirements-single.rst cat them and merge
+        for file in $DOC_DIR/source/requirements_managed.rst; do
+            cat "$file" >> $DOC_DIR/source/requirements-single.rst;
+        done
+    else
+        # When unable to merge remove the auto generated RST so that is apparent
+        # it is not generated and will diff in a 'git status'
+        rm -rf $DOC_DIR/source/requirements-single.rst
+    fi
+fi
@@ -0,0 +1,40 @@
+#!/bin/sh
+
+################################################################################
+# © Copyright IBM Corporation 2020
+################################################################################
+
+################################################################################
+# Script and actions called after generating doc, helpful in cases where
+# customization is needed but does not apply to all collections
+################################################################################
+SCRIPT_PATH=`dirname "$0"`
+DOC_DIR=`( cd "$SCRIPT_PATH" && pwd )| sed 's|\(.*\)/.*|\1|'`
+# `pwd| sed 's|\(.*\)/.*|\1|'`
+
+################################################################################
+# Delete the playbook-single.rst
+################################################################################
+
+if [[ -f $DOC_DIR/source/playbooks-single.rst  ]]; then
+    #echo "Deleting file [$DOC_DIR/source/playbooks-single.rst]";
+    rm -rf $DOC_DIR/source/playbooks-single.rst
+fi
+
+################################################################################
+# Delete the requirements-single.rst
+################################################################################
+
+if [[ -f $DOC_DIR/source/requirements-single.rst  ]]; then
+    #echo "Deleting file [$DOC_DIR/source/requirements-single.rst]";
+    rm -rf $DOC_DIR/source/requirements-single.rst
+fi
+
+################################################################################
+# Replace the temporary index
+################################################################################
+
+if [[ -f $DOC_DIR/source/index.org  ]]; then
+    #echo "Replace [$DOC_DIR/source/index.rst] with [$DOC_DIR/source/index.org]"
+    mv $DOC_DIR/source/index.org $DOC_DIR/source/index.rst
+fi
@@ -0,0 +1,110 @@
+#!/bin/sh
+
+################################################################################
+# © Copyright IBM Corporation 2020
+################################################################################
+
+################################################################################
+# Script and actions called before generating doc, helpful in cases where
+# customization is needed but does not apply to all collections
+################################################################################
+SCRIPT_PATH=`dirname "$0"`
+DOC_DIR=`( cd "$SCRIPT_PATH" && pwd )| sed 's|\(.*\)/.*|\1|'`
+# `pwd| sed 's|\(.*\)/.*|\1|'`
+
+################################################################################
+# Source the playbook*.rst into a single RST so that our topic is a single html
+################################################################################
+
+# Delete any temporary index RST
+if [[ -f $DOC_DIR/source/index-temp.rst  ]]; then
+    #echo "Deleting file [$DOC_DIR/source/index-temp.rst]"
+    rm -rf $DOC_DIR/source/index-temp.rst
+
+    if [[ -f $DOC_DIR/source/index.org ]]; then
+        #echo "Moving file [$DOC_DIR/source/index.org] to [$DOC_DIR/source/index.rst]"
+        mv $DOC_DIR/source/index.org $DOC_DIR/source/index.rst
+    fi
+fi
+
+# Remove all the toctree entries from playbooks.rst as a new RST playbooks-single.rst
+if [[ -f $DOC_DIR/source/playbooks.rst ]]; then
+    #echo "Creating [$DOC_DIR/source/playbooks-single.rst] with no toctree entries."
+
+    # Remove the toctree entries
+    awk '/toctree/ {exit} {print}' $DOC_DIR/source/playbooks.rst >> $DOC_DIR/source/playbooks-single.rst
+
+    # Concat the interested RSTs into playbooks-single.rst to create a single RST
+    if [[ -f $DOC_DIR/source/playbook_config_setup.rst && -f $DOC_DIR/source/playbook_inventory.rst && -f $DOC_DIR/source/playbook_group_vars.rst && -f $DOC_DIR/source/playbook_run.rst ]]; then
+
+        for file in $DOC_DIR/source/playbook_config_setup.rst $DOC_DIR/source/playbook_inventory.rst $DOC_DIR/source/playbook_group_vars.rst $DOC_DIR/source/playbook_run.rst; do
+            #echo "Merging $file into [$DOC_DIR/source/playbooks-single.rst]."
+            cat "$file" >> $DOC_DIR/source/playbooks-single.rst;
+        done
+
+        # Update the temporary index-temp.rst toctree with a new RST playbooks-single entry
+        if [[ -f $DOC_DIR/source/playbooks-single.rst ]]; then
+            #echo "Updating [index-temp.rst] with toctree entry [$DOC_DIR/source/playbooks-single.rst]."
+            awk '{ sub(/^   playbooks$/,"   playbooks-single"); print }' $DOC_DIR/source/index.rst > $DOC_DIR/source/index-temp.rst
+        fi
+    else
+        #echo "Unable to merge playbook*.rst files a single [playbooks-single.rst]."
+
+        #echo "Removing [$DOC_DIR/source/playbooks-single.rst]."
+        rm -rf $DOC_DIR/source/playbooks-single.rst
+
+        #echo "Removing [$DOC_DIR/source/index-temp.rst]."
+        rm -rf $DOC_DIR/source/index-temp.rst
+    fi
+#else
+#    #echo "Unable to create single source RST for [$DOC_DIR/source/playbooks.rst]."
+fi
+
+# Remove all the toctree entries from requirements.rst as a new RST requirements-single.rst
+if [[ -f $DOC_DIR/source/requirements.rst ]]; then
+    #echo "Creating [$DOC_DIR/source/requirements-single.rst] with no toctree entries."
+
+    # Remove the toctree entries
+    awk '/toctree/ {exit} {print}' $DOC_DIR/source/requirements.rst >> $DOC_DIR/source/requirements-single.rst
+
+    # Concat the interested RSTs into requirements-single.rst to create a single RST
+    if [[ -f $DOC_DIR/source/requirements_managed.rst ]]; then
+
+        for file in $DOC_DIR/source/requirements_managed.rst; do
+            #echo "Merging $file into [$DOC_DIR/source/requirements-single.rst]."
+            cat "$file" >> $DOC_DIR/source/requirements-single.rst;
+        done
+
+### we need a check if index-temp here else do ...
+        # Update the temporary index-temp.rst toctree with a new RST playbooks-single entry
+        if [[ -f $DOC_DIR/source/requirements-single.rst ]]; then
+            # echo "Updating [index-temp.rst] with toctree entry [$DOC_DIR/source/requirements-single.rst]."
+
+            if [[ -f $DOC_DIR/source/index-temp.rst ]]; then
+                awk '{ sub(/^   requirements$/,"   requirements-single"); print }' $DOC_DIR/source/index-temp.rst > $DOC_DIR/source/index-temp-temp.rst
+                mv $DOC_DIR/source/index-temp-temp.rst $DOC_DIR/source/index-temp.rst
+            else
+                awk '{ sub(/^   requirements$/,"   requirements-single"); print }' $DOC_DIR/source/index.rst > $DOC_DIR/source/index-temp.rst
+            fi
+        fi
+    else
+        #echo "Unable to merge requirements*.rst files a single [requirements-single.rst]."
+
+        #echo "Removing [$DOC_DIR/source/requirements-single.rst]."
+        rm -rf $DOC_DIR/source/requirements-single.rst
+
+        #echo "Removing [$DOC_DIR/source/index-temp.rst]."
+        rm -rf $DOC_DIR/source/index-temp.rst
+    fi
+#else
+#    #echo "Unable to create single source RST for [$DOC_DIR/source/playbooks.rst]."
+fi
+
+# Backup the original index.rst (without rst extenstion) and move the temporary one
+if [[ -f $DOC_DIR/source/index-temp.rst  ]]; then
+    #echo "Backing up [$DOC_DIR/source/index.rst] as [$DOC_DIR/source/index.org]"
+    mv $DOC_DIR/source/index.rst $DOC_DIR/source/index.org
+
+    #echo "Replacing [$DOC_DIR/source/index-temp.rst] as [$DOC_DIR/source/index.rst]"
+    mv $DOC_DIR/source/index-temp.rst $DOC_DIR/source/index.rst
+fi
@@ -2,6 +2,7 @@
 .. © Copyright IBM Corporation 2020                                          .
 .. ...........................................................................
 
+============
 Contributing
 ============
 
@@ -15,6 +16,7 @@ contributions in the future. For the latest information on open issues, see:
 .. _git issues:
    https://github.com/ansible-collections/ibm_zos_core/issues
 
+
 Development
 ===========
 
@@ -26,7 +28,6 @@ Ansible modules.
 
 .. toctree::
    :maxdepth: 1
-   :caption: Contents:
    :glob:
 
    community_guides_docs/zos_ansible_module_testing
@@ -49,17 +50,6 @@ provides examples of dependencies and more:
 
 .. toctree::
    :maxdepth: 1
-   :caption: Contents:
    :glob:
 
    community_guides_docs/better_arg_parser
-
-Helpful Links
-=============
-
-* Getting Started `Ansible guide`_.
-
-.. _Ansible guide:
-   https://docs.ansible.com/ansible/latest/user_guide/intro_getting_started.html
-
-
@@ -47,7 +47,10 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
+exclude_patterns = ['playbooks.rst', 'playbook_config_setup.rst',
+                    'playbook_group_vars.rst', 'playbook_inventory.rst',
+                    'playbook_run.rst', 'requirements.rst',
+                    'requirements_managed.rst']
 
 ##############################################################################
 # Options for HTML output
@@ -147,7 +150,7 @@
 # White list which Git tags documentation will be generated and linked into the
 # version selection box. This is currently a manual selection, until more
 # versions are released, there are no regular expressions used.
-scv_whitelist_tags = ('v1.0.0', 'v1.1.0', 'v1.2.0-beta.1')
+scv_whitelist_tags = ('v1.0.0', 'v1.1.0', 'v1.2.0-beta.1', 'v1.2.0-beta.2')
 
 # Sort versions by one or more values. Valid values are semver, alpha, and time.
 # Semantic is referred to as 'semver', this would ensure our latest VRM is
@@ -168,4 +171,9 @@
 # Override banner-main-ref to be the tag with the highest version number. If no
 # tags have docs then this option is ignored and --banner-main-ref is used.
 # The greatest tag is desirable behavior for this site.
-scv_banner_greatest_tag = True
+# scv_banner_greatest_tag = True
+
+# Temporary work around to promote the latest git tag in the banner, for some
+# reason pre-release semantic versioning used with scv_banner_greatest_tag does
+# not generate the correct latest banner.
+scv_banner_recent_tag = True