[ELITERT-1198] Generate reports alongside documentation

* Changes the documentation generation action to include the generation
  of the following reports:

 - Test Results Report (generated by RSpec)
 - Code Coverage (generated by SimpleCOV)
 - Static Code Analysis (generated by Rubocop)

* Changes the links in the "Links and Resources" page of the
  documentation to make them point to the generated assets instead of
  the internal Jenkins locations.

.github/workflows/sphinx-doc.yml

@@ -3,6 +3,9 @@
 name: Sphinx Documentation
 
 on:
+  # REMOVE THIS BEFORE MERGING!!!!
+  pull_request:
+    branches: [ "master" ]
   push:
     branches: [ "master" ]
 
@@ -14,6 +17,9 @@ jobs:
 
     runs-on: ubuntu-latest
 
+    env:
+      COVERAGE: true
+
     steps:
     - uses: actions/checkout@v4
     - name: Set up Ruby
@@ -24,6 +30,15 @@ jobs:
       with:
         ruby-version: 2.7.7
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Test Results and Coverage
+      run:
+        bundler exec rspec --format html -o documentation/build/html/test_results/index.html
+    - name: Move Coverage Report
+      run:
+        mv coverage documentation/build/html/coverage
+    - name: Static Analysis Report
+      run:
+        bundler exec rubocop . --format html -o documentation/build/html/static_code_analysis/index.html || true
     - name: Generate YARD documentation
       run: |
         bundler exec yard doc . --exclude vendor/ -o documentation/build/html/yard

documentation/source/appendix/links_and_resources.rst

@@ -25,17 +25,17 @@ Build Infrastructure
 Test Results
 ------------
 
-* `Tests Results <https://jenkins.int.esrlabs.com/job/Testing-Tools/job/dragnet/job/dragnet-verifier/Test_20Results/>`_
+* `Tests Results <../test_results/index.html>`_
 
 Static Code Analysis
 --------------------
 
-* `Rubocop Report <https://jenkins.int.esrlabs.com/job/Testing-Tools/job/dragnet/job/dragnet-verifier/Rubocop_20Report/>`_
+* `Rubocop Report <../static_code_analysis/index.html>`_
 
 Code Coverage
 -------------
 
-* `Code Coverage Report <https://jenkins.int.esrlabs.com/job/Testing-Tools/job/dragnet/job/dragnet-verifier/Coverage_20Report/>`_
+* `Code Coverage Report <../coverage/index.html>`_
 
 Requirements Coverage
 ---------------------