[PATCH 3/4] ci: add workflow to check documentation build is warning free
Ahmad Fatoum
a.fatoum at pengutronix.de
Fri Nov 28 10:49:16 PST 2025
With latest changes, we have a warning-free documentation build.
Add a CI check that builds the docs and translates warnings to
annotations on Github.
Signed-off-by: Ahmad Fatoum <a.fatoum at pengutronix.de>
---
.github/workflows/sphinx-docs.yml | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
create mode 100644 .github/workflows/sphinx-docs.yml
diff --git a/.github/workflows/sphinx-docs.yml b/.github/workflows/sphinx-docs.yml
new file mode 100644
index 000000000000..6d9745d9fd5a
--- /dev/null
+++ b/.github/workflows/sphinx-docs.yml
@@ -0,0 +1,17 @@
+name: Pull Request Docs Check
+
+on: [push, pull_request]
+
+jobs:
+ docs:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout code
+ uses: actions/checkout at v4
+
+ - name: Build docs
+ uses: ammaraskar/sphinx-action at master
+ with:
+ docs-folder: "Documentation/"
+ build-command: "make htmldocs"
--
2.47.3
More information about the barebox
mailing list