xd

.github/workflows/build.yml

@@ -0,0 +1,61 @@
+# vim:sw=2:ts=2
+# build html version of docs
+name: build
+
+# on events
+on:
+  pull_request:
+    branches:
+      - master
+      - 'feature/*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: build
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: sphinx-doc/github-problem-matcher@master
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Build docs
+        run: |
+          make clean html
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: html_build
+          path: _build
+          if-no-files-found: error
+
+  deploy:
+    runs-on: ubuntu-latest
+    name: deploy-on-merge
+    needs: build
+
+    steps:
+      - name: Download build artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: html_build
+          path: _build
+          if-no-files-found: error
+
+      - name: Install lftp
+        run: |
+          sudo apt install -y lftp
+
+      - name: Deploy docs
+        run: |
+          lftp -p 11022 -c "open lftp:[email protected]; put -R _build"

.github/workflows/deploy.yml

@@ -0,0 +1,49 @@
+# vim:sw=2:ts=2
+# build html version of docs and deploy to docs.phoenix-rtos.com
+name: deploy
+
+# on events
+on:
+  push:
+    branches:
+      - master
+      - 'feature/*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: build
+
+    steps:
+      name: Build docs
+      uses: phoenix-rtos/phoenix-rtos-project/phoenix-rtos-doc/.github/workflows/build.yml@master
+
+      name: Upload artifact
+      uses: actions/upload-artifact@v4
+        with:
+          name: html_build
+          path: _build
+          if-no-files-found: error
+
+  deploy:
+    runs-on: ubuntu-latest
+    name: deploy-on-merge
+    needs: build
+
+    steps:
+      - name: Download build artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: html_build
+          path: _build
+          if-no-files-found: error
+
+      - name: Deploy docs
+        run: |
+          touch key
+          echo "" > key
+          sftp -i key -P 11022 [email protected] <<EOF
+          cd uploads
+          put -R _build
+          bye
+          EOF

requirements.txt

@@ -0,0 +1,5 @@
+sphinx==7.2.6
+sphinx_copybutton==0.5.2
+myst-parser==2.0.0
+furo==2024.1.29
+pygments==2.17.2