Merge pull request #257 from sehlen-bsi/audit/enable_srcref

Enable :srcref: in audit report document
sehlen-bsi · Oct 29, 2024 · 737358c · 737358c
2 parents 28d2c30 + e624d4f
commit 737358c
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -147,6 +147,14 @@ jobs:
           AUDIT_REPO_LOCATION: ${{ github.workspace }}/botan
           BASIC_GH_TOKEN: ${{ github.token }}
 
+      - name: Check Source Links
+        working-directory: source/docs/audit_report
+        run: poetry run make SPHINXOPTS="-D src_ref_check_url=True -W --keep-going" html
+        env:
+          AUDIT_CACHE_LOCATION: ${{ github.workspace }}/audit_generator_cache
+          AUDIT_REPO_LOCATION: ${{ github.workspace }}/botan
+          BASIC_GH_TOKEN: ${{ github.token }}
+
       - name: Query the API Rate Limit
         run: ${{ github.workspace }}/source/.github/scripts/query_rate_limit.sh
         if: always()

diff --git a/docs/audit_report/src/conf.py b/docs/audit_report/src/conf.py
@@ -39,6 +39,7 @@
 # ones.
 extensions = [
   'sphinx.ext.todo',
+  'sourceref',
 ]
 
 # Add any paths that contain templates here, relative to this directory.