add build workflow

.github/workflows/build.yml

@@ -0,0 +1,33 @@
+# 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 SPHINXOPTS="-W --keep-going -n"

README.md

@@ -3,7 +3,7 @@
 The full documentation can be found on <https://docs.phoenix-rtos.com/>.
 
 This repository contains all the necessary files needed to build
-Phoenix-RTOS Documentation using [https://github.com/sphinx-doc/sphinx](sphinx).
+Phoenix-RTOS Documentation using [sphinx](https://github.com/sphinx-doc/sphinx).
 
 It can be done using the following command:
 

conf.py

@@ -19,7 +19,7 @@
 ]
 
 templates_path = ['_templates']
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ['README.md', '_build', 'Thumbs.db', '.DS_Store']
 myst_heading_anchors = 3
 pygments_dark_style = 'tango'
 

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