Adding workflow to create Cordio platform docs.

.github/workflows/build-cordio-platform-docs.yml

@@ -0,0 +1,60 @@
+name: Build & Deploy Cordio Platform Docs
+
+on:
+  workflow_dispatch:
+
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/github-script@v3
+        id: get-pr
+        with:
+          script: |
+            const request = {
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              pull_number: context.issue.number
+            }
+            core.info(`Getting PR #${request.pull_number} from ${request.owner}/${request.repo}`)
+            try {
+              const result = await github.pulls.get(request)
+              return result.data
+            } catch (err) {
+              core.setFailed(`Request failed with error ${err}`)
+            }
+      - uses: actions/checkout@v3
+        with:
+          repository: ${{ fromJSON(steps.get-pr.outputs.result).head.repo.full_name }}
+          ref: ${{ fromJSON(steps.get-pr.outputs.result).head.ref }}
+          fetch-depth: 0
+
+      - name: Generate Docs (MAX32655)
+        uses: mattnotmitt/[email protected]
+        with:
+          working-directory: Libraries/Cordio/docs
+          doxyfile-path: cordio_platform_doxyfile
+          enable-latex: true
+
+      - name: Build PDF
+        run: |
+          echo "Building PDF..."
+          sudo apt-get install texlive-full
+          sudo make -C Libraries/Cordio/docs/latex
+
+          echo "Copying PDF to Cordio/platform/Documentation"
+          sudo mv Libraries/Cordio/docs/latex/refman.pdf Libraries/Cordio/docs/latex/Cordio-Platform-Documentation.pdf
+          sudo mkdir -p Libraries/Cordio/platform/Documentation && sudo cp -r Libraries/Cordio/docs/latex/Cordio-Platform-Documentation.pdf Libraries/Cordio/platform/Documentation/
+
+
+      - name: Push Documentation Files
+        uses: EndBug/[email protected]
+        with:
+          add: 'Libraries/Cordio/platform/Documentation/Platform_ref.pdf'
+          message: 'Update documentation.'
+          push: true
+
+
+
+

.github/workflows/build-docs.yml

@@ -133,6 +133,12 @@ jobs:
 
           echo "Copying any root markdown files into Documentation..."
           cp -r *.md Documentation/
+          echo "Copying any Cordio markdown files into Documentation..."
+          cp -r Libraries/Cordio/docs/*.md Documentation/
+          cp -r Libraries/Cordio/docs/res/* Documentation/res/
+          cp -r Libraries/Cordio/platform/Documentation/*.pdf Documentation/
+
+          python3 Documentation/updateUSERGUIDE-Cordio.py
 
           mkdocs build
 

Documentation/USERGUIDE.md

@@ -1584,6 +1584,12 @@ The Cordio Bluetooth Low Energy (BLE) library provides a full BLE stack for micr
 - MAX32680
 - MAX32690
 
+#### Cordio Documentation
+
+- [Architecture](ARCHITECTURE.md)
+- [Bluetooth LE Basics](BLUETOOTH_LE_BASICS.md)
+- [Packetcraft](PACKETCRAFT.md)
+
 ---
 
 ### MAXUSB
@@ -1617,3 +1623,4 @@ The **Secure Digital High Capacity *(SDHC)*** library offers a higher-level inte
 - MAX32570
 - MAX32665-MAX32668
 - MAX78002
+

Documentation/updateUSERGUIDE-Cordio.py

@@ -0,0 +1,67 @@
+from pathlib import Path
+from os import listdir
+
+
+TEMPLATE = "- [%s](%s)\n"
+here = Path.cwd()
+repo = here.parent
+cordio_docs_dir =  repo / "Libraries" / "Cordio" / "docs"
+platform_docs_dir = repo / "Libraries" / "Cordio" / "platform" / "Documentation"
+
+cordio_doc_files = [f for f in listdir(cordio_docs_dir) if f.endswith('.md')]
+platform_doc_files = [f for f in listdir(platform_docs_dir) if f.endswith('.pdf')]
+
+with open('USERGUIDE.md', 'r') as f:
+    lines = f.readlines()
+
+idx = 0
+foundStart = False
+
+for line in lines:
+    if foundStart:
+        if line[0] == '#':
+            end_idx = idx
+            break
+
+    if '#### Cordio Documentation' in line:
+        start_idx = idx
+        foundStart = True
+
+    idx += 1
+
+comp_lines = lines[start_idx+1:end_idx]
+new_files = cordio_doc_files + platform_doc_files
+
+for cfile in cordio_doc_files:
+    for line in lines:
+        if cfile in line:
+            new_files.remove(cfile)
+
+for pfile in platform_doc_files:
+    for line in lines:
+        if pfile in line:
+            new_files.remove(pfile)
+
+if len(new_files) > 0:
+    entries = []
+    for f in new_files:
+        if 'LICENSE' in f:
+            continue
+        nav_name = f.split('.')[0].title()
+        entries.append(TEMPLATE % (nav_name, f))
+
+    while True:
+        if lines[end_idx][0] == '-':
+            end_idx -= 1
+            break
+        end_idx -= 1
+
+    idx = 0
+    for entry in entries:
+        lines.insert(end_idx, entry)
+        end_idx += 1
+
+    content = "".join(lines)
+
+    with open('USERGUIDE.md', 'w') as f:
+        f.write(content)