Skip to content

Commit dd5076e

Browse files
CopilotRafaelAPB
andcommitted
fix doc publishing via mkdocs; include SATP Hermes docs in mkdocs build
Co-authored-by: RafaelAPB <11261236+RafaelAPB@users.noreply.github.com>
1 parent 72ff4d5 commit dd5076e

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

.github/workflows/deploy_docs.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ on:
1111

1212
paths:
1313
- 'docs/**'
14+
- 'packages/cactus-plugin-satp-hermes/docs/**'
1415

1516
# Allows you to run this workflow manually from the Actions tab
1617
workflow_dispatch:
@@ -46,9 +47,34 @@ jobs:
4647
run: pip install -r requirements.txt
4748
working-directory: docs
4849

50+
- name: Install system dependencies for Mermaid diagrams
51+
run: |
52+
sudo apt-get update
53+
sudo apt-get install -y \
54+
libnss3 \
55+
libatk-bridge2.0-0 \
56+
libdrm2 \
57+
libxkbcommon0 \
58+
libxcomposite1 \
59+
libxdamage1 \
60+
libxfixes3 \
61+
libxrandr2 \
62+
libgbm1 \
63+
libasound2
64+
4965
- name: Build packages
5066
run: npm run configure
5167

68+
- name: Build SATP Hermes diagrams
69+
run: yarn docs:diagrams
70+
working-directory: packages/cactus-plugin-satp-hermes
71+
72+
- name: Copy SATP Hermes docs to mkdocs
73+
run: |
74+
mkdir -p docs/docs/satp-hermes/assets
75+
cp -r packages/cactus-plugin-satp-hermes/docs/architecture docs/docs/satp-hermes/
76+
cp -r packages/cactus-plugin-satp-hermes/assets/diagrams docs/docs/satp-hermes/assets/
77+
5278
- name: Build markdown for openapi specs
5379
run: 'python3 docs/scripts/publish_openapi.py'
5480

docs/mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,8 @@ nav:
190190
- Specifications: weaver/specifications.md
191191
- Roadmap: weaver/roadmap.md
192192
- Publications: weaver/publications.md
193+
- SATP Hermes:
194+
- Architecture: satp-hermes/architecture/satp-hermes.md
193195
- Guides:
194196
- Operations: guides/operations.md
195197
- Developers: guides/developers.md

0 commit comments

Comments
 (0)