From 9365d38162047e142adbfb8ee0085bdd836717f6 Mon Sep 17 00:00:00 2001
From: Guido Grazioli <ggraziol@redhat.com>
Date: Thu, 31 Mar 2022 16:51:25 +0200
Subject: [PATCH] docs: add role index to toctree

---
 .github/workflows/docs.yml    |  5 ++++-
 .github/workflows/release.yml | 13 +++++++++++++
 docs/roles.rst.template       |  1 +
 3 files changed, 18 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 3901e7c..28ae026 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -51,7 +51,10 @@ jobs:
           mkdir -p ./docs/plugins ./docs/roles
           cat ./docs/roles.rst.template > ./docs/roles/index.rst
           antsibull-docs collection --use-current --squash-hierarchy --dest-dir docs/plugins  middleware_automation.keycloak
-          for role_readme in roles/*/README.md; do ln -f -s ../../$role_readme ./docs/roles/$(basename $(dirname $role_readme)).md; echo " * :doc:\`$(basename $(dirname $role_readme))\`" >> ./docs/roles/index.rst; done
+          for role_readme in roles/*/README.md; do
+            ln -f -s ../../$role_readme ./docs/roles/$(basename $(dirname $role_readme)).md
+            echo "    $(basename $(dirname $role_readme))" >> ./docs/roles/index.rst
+          done
         working-directory: ansible_collections/middleware_automation/keycloak
 
       - name: Scan PR merges from latest tag
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 2471420..a99d01d 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -17,32 +17,40 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
+
       - name: Fetch tags
         run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
+
       - name: Set up Python
         uses: actions/setup-python@v1
         with:
           python-version: "3.x"
+
       - name: Get current version
         id: get_version
         run: echo "::set-output name=TAG_VERSION::$(grep version galaxy.yml | awk -F'"' '{ print $2 }')"
+
       - name: Check if tag exists
         id: check_tag
         run: echo "::set-output name=TAG_EXISTS::$(git tag | grep ${{ steps.get_version.outputs.TAG_VERSION }})"
+
       - name: Fail if tag exists
         if: ${{ steps.get_version.outputs.TAG_VERSION == steps.check_tag.outputs.TAG_EXISTS }}
         uses: actions/github-script@v3
         with:
           script: |
               core.setFailed('Release tag already exists')
+
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install ansible-core antsibull
           sudo apt install -y sed hub
+
       - name: Build collection
         run: |
           ansible-galaxy collection build .
+
       - name: Scan PR merges from latest tag
         run: |
           TYPES=("minor_changes" "major_changes" "bugfixes" "deprecated_features" "removed_features" "breaking_changes")
@@ -63,6 +71,7 @@ jobs:
           antsibull-changelog release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Commit changelogs
         run: |
           git config user.name github-actions
@@ -70,17 +79,20 @@ jobs:
           git add CHANGELOG.rst changelogs/changelog.yaml
           git commit -m "Update changelog for release ${{ steps.get_version.outputs.TAG_VERSION }}" || true
           git push origin
+
       - name: Publish collection
         env:
           ANSIBLE_GALAXY_API_KEY: ${{ secrets.ANSIBLE_GALAXY_API_KEY }}
         run: |
           ansible-galaxy collection publish *.tar.gz --api-key $ANSIBLE_GALAXY_API_KEY
+
       - name: Create release tag
         run: |
           git config user.name github-actions
           git config user.email github-actions@github.com
           git tag -a ${{ steps.get_version.outputs.TAG_VERSION }}" -m "Release v${{ steps.get_version.outputs.TAG_VERSION }}" || true
           git push origin --tags
+
       - name: Publish Release
         uses: softprops/action-gh-release@v1
         env:
@@ -88,6 +100,7 @@ jobs:
         with:
           files: "*.tar.gz"
           body: "Release v${{ steps.get_version.outputs.TAG_VERSION }}"
+
   dispatch:
     needs: release
     strategy:
diff --git a/docs/roles.rst.template b/docs/roles.rst.template
index b025af6..52dfdcd 100644
--- a/docs/roles.rst.template
+++ b/docs/roles.rst.template
@@ -1,3 +1,4 @@
 Role Index
 ==========
 
+.. toctree::