docs(generated_files): update generation script (#1449)

**Issue number:** N/A ## Summary ### Changes Update generated files Python script to reflect documentation changes done in #1393. ### User experience N/A ## Checklist If your change doesn't seem to apply, please leave them unchecked. * [x] I have performed a self-review of this change * [ ] Changes have been tested * [ ] Changes are documented * [x] PR title follows [conventional commit semantics](https://www.conventionalcommits.org/en/v1.0.0/) --------- Co-authored-by: srv-rr-github-token <[email protected]>
splunk · Nov 12, 2024 · c743559 · c743559
1 parent 8ccdc0a
commit c743559
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 17 deletions.
diff --git a/.github/workflows/automatic_doc_generation.yml b/.github/workflows/automatic_doc_generation.yml
@@ -44,4 +44,4 @@ jobs:
         if: ${{ env.isPR }}
         run: |
           git add \*.md
-          git diff --staged --exit-code || (git commit -S -m "doc: updated docs regarding generated conf, xml and html files" && git push)
+          git diff --staged --exit-code || (git commit -S -m "docs: updated docs regarding generated conf, xml and html files" && git push)
diff --git a/docs/generated_files.md b/docs/generated_files.md
@@ -4,7 +4,7 @@ title: UCC framework generated files
 
 The following table describes the files generated by UCC framework.
 
-| File name  | File location | File description |
+| File Name  | File Location | File Description |
 | ------------ | ------------ | ----------------- |
 | app.conf | output/&lt;YOUR_ADDON_NAME&gt;/default | Generates `app.conf` with the details mentioned in globalConfig[meta] |
 | inputs.conf | output/&lt;YOUR_ADDON_NAME&gt;/default | Generates `inputs.conf` and `inputs.conf.spec` file for the services mentioned in globalConfig |

diff --git a/splunk_add_on_ucc_framework/generators/doc_generator.py b/splunk_add_on_ucc_framework/generators/doc_generator.py
@@ -25,11 +25,7 @@ def generate_docs() -> None:
 title: UCC framework generated files
 ---
 
-# Generated files
-
-Below table describes the files generated by UCC framework
-
-## File Description
+The following table describes the files generated by UCC framework.
 """
     )
     doc_content.append("| File Name  | File Location | File Description |")

diff --git a/tests/unit/generators/test_doc_generator.py b/tests/unit/generators/test_doc_generator.py
@@ -34,11 +34,7 @@ def test_generate_docs(mock_open, mock_dirname, mock_realpath):
             "title: UCC framework generated files",
             "---",
             "",
-            "# Generated files",
-            "",
-            "Below table describes the files generated by UCC framework",
-            "",
-            "## File Description",
+            "The following table describes the files generated by UCC framework.",
             "",
             "| File Name  | File Location | File Description |",
             "| ------------ | ------------ | ----------------- |",
@@ -75,11 +71,7 @@ def test_generate_docs_empty_list(mock_open_file, mock_dirname, mock_realpath):
             "title: UCC framework generated files",
             "---",
             "",
-            "# Generated files",
-            "",
-            "Below table describes the files generated by UCC framework",
-            "",
-            "## File Description",
+            "The following table describes the files generated by UCC framework.",
             "",
             "| File Name  | File Location | File Description |",
             "| ------------ | ------------ | ----------------- |",