mail archive of the barebox mailing list
 help / color / mirror / Atom feed
From: Ahmad Fatoum <a.fatoum@pengutronix.de>
To: barebox@lists.infradead.org
Cc: Ahmad Fatoum <a.fatoum@pengutronix.de>
Subject: [PATCH 3/4] ci: add workflow to check documentation build is warning free
Date: Fri, 28 Nov 2025 19:49:16 +0100	[thread overview]
Message-ID: <20251128184920.109552-3-a.fatoum@pengutronix.de> (raw)
In-Reply-To: <20251128184920.109552-1-a.fatoum@pengutronix.de>

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@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@v4
+
+    - name: Build docs
+      uses: ammaraskar/sphinx-action@master
+      with:
+        docs-folder: "Documentation/"
+        build-command: "make htmldocs"
-- 
2.47.3




  parent reply	other threads:[~2025-11-28 18:49 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-28 18:49 [PATCH 1/4] Documentation: migration-guides: don't warn about migration-master Ahmad Fatoum
2025-11-28 18:49 ` [PATCH 2/4] Documentation: factor out build rules into stand-alone Makefile Ahmad Fatoum
2025-11-28 18:49 ` Ahmad Fatoum [this message]
2025-11-28 18:49 ` [PATCH 4/4] ARM: Rockchip: document changing console baud rate Ahmad Fatoum
2025-12-01 11:09 ` [PATCH 1/4] Documentation: migration-guides: don't warn about migration-master Sascha Hauer

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20251128184920.109552-3-a.fatoum@pengutronix.de \
    --to=a.fatoum@pengutronix.de \
    --cc=barebox@lists.infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox