Everest/charge som add git submodules

.github/workflows/linkcheck.yml

@@ -11,9 +11,17 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v1
+    - name: Checkout repository with submodules
+      uses: actions/checkout@v4
+      with:
+        submodules: recursive
+        fetch-depth: 0
+
+    - name: Initialize and update submodules
+      run: git submodule update --init --recursive
     # This external action cares about all the sphinx stuff
-    - uses: ammaraskar/[email protected]
+    - name: Build project
+      uses: ammaraskar/[email protected]
       with:
         build-command: "sphinx-build -b linkcheck source/ build/"
         docs-folder: "docs/"

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "includes"]
+	path = includes
+	url = https://github.com/chargebyte/chargebyte-docs.git
+	branch = shared-docs

.readthedocs.yaml

@@ -11,3 +11,6 @@ python:
 
 sphinx:
   configuration: docs/source/conf.py
+
+submodules:
+  include: all #includes all git-submodules

README.rst

@@ -12,6 +12,13 @@ Contents:
 
 - Charge SOM User Guide
 
+Repo initialization:
+-------------------
+This repository is using git submodules to share documents between the user guides.
+After cloning of the project please execute the following command:
+
+git submodule update --init --force --remote
+
 
 Building the documentation locally:
 -----------------------------------