Dylan Aïssi pushed to branch wip/daissi/enable-docs at X Strike Force / wayland 
/ weston


Commits:
116ac817 by Dylan Aïssi at 2025-09-16T14:59:59+02:00
Build Weston documentation

Signed-off-by: Dylan Aïssi <[email protected]>

- - - - -


7 changed files:

- debian/changelog
- debian/control
- + debian/patches/Fix-sphinx-8-compatibility.patch
- + debian/patches/series
- debian/rules
- debian/salsa-ci.yml
- + debian/weston-doc.install


Changes:

=====================================
debian/changelog
=====================================
@@ -1,3 +1,10 @@
+weston (14.0.2-2) UNRELEASED; urgency=medium
+
+  * Build Weston documentation and install it in weston-doc.
+  * salsa-ci: add jobs to test nodoc profile and cross-build.
+
+ -- Dylan Aïssi <[email protected]>  Tue, 16 Sep 2025 14:57:47 +0200
+
 weston (14.0.2-1) unstable; urgency=medium
 
   * New upstream release.


=====================================
debian/control
=====================================
@@ -53,6 +53,10 @@ Build-Depends: debhelper-compat (= 13),
                pkgconf,
                wayland-protocols (>= 1.33),
                xwayland
+Build-Depends-Indep:
+               python3-breathe <!nodoc>,
+               python3-sphinx <!nodoc>,
+               python3-sphinx-rtd-theme <!nodoc>,
 Standards-Version: 4.7.2
 Vcs-Browser: https://salsa.debian.org/xorg-team/wayland/weston
 Vcs-Git: https://salsa.debian.org/xorg-team/wayland/weston.git
@@ -90,6 +94,21 @@ Description: reference implementation of a wayland 
compositor (headers)
  .
  This package includes the weston headers for plugin development.
 
+Package: weston-doc
+Section: doc
+Build-Profiles: <!nodoc>
+Architecture: all
+Multi-Arch: foreign
+Depends: ${misc:Depends}
+Description: reference implementation of a wayland compositor (doc)
+ Part of the Wayland project is also the Weston reference implementation
+ of a Wayland compositor. Weston can run as an X client or under Linux
+ KMS and ships with a few demo clients. The Weston compositor is a minimal
+ and fast compositor and is suitable for many embedded and mobile use
+ cases.
+ .
+ This package contains the Weston documentation.
+
 Package: libweston-14-0
 Architecture: linux-any
 Multi-Arch: same


=====================================
debian/patches/Fix-sphinx-8-compatibility.patch
=====================================
@@ -0,0 +1,16 @@
+Description: Fix compatibility with sphinx 8.x. Otherwise it FTBFS with:
+ ERROR: Invalid value `None` in 
intersphinx_mapping['https://docs.python.org/'].
+Forwarded: not-needed
+Origin: upstream, 
https://gitlab.freedesktop.org/wayland/weston/-/commit/a40c6380
+
+--- a/doc/sphinx/conf.py.in
++++ b/doc/sphinx/conf.py.in
+@@ -196,7 +196,7 @@
+ # -- Options for intersphinx extension ---------------------------------------
+ 
+ # Example configuration for intersphinx: refer to the Python standard library.
+-intersphinx_mapping = {'https://docs.python.org/3': None}
++intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
+ 
+ # -- Options for todo extension ----------------------------------------------
+ 


=====================================
debian/patches/series
=====================================
@@ -0,0 +1 @@
+Fix-sphinx-8-compatibility.patch


=====================================
debian/rules
=====================================
@@ -8,12 +8,19 @@ else
 BACKEND_VNC=true
 endif
 
+ifeq (,$(filter weston-doc,$(shell dh_listpackages)))
+CONFIGURE_FLAGS = -Ddoc=false
+else
+CONFIGURE_FLAGS = -Ddoc=true
+endif
+
 override_dh_auto_configure:
        dh_auto_configure -- \
                -Dbackend-rdp=true \
                -Dbackend-vnc=$(BACKEND_VNC) \
                -Dscreenshare=true \
-               -Dsystemd=true
+               -Dsystemd=true \
+               $(CONFIGURE_FLAGS)
 
 override_dh_auto_test:
        mkdir -p $(CURDIR)/debian/tmp/tmp/xdgruntimedir


=====================================
debian/salsa-ci.yml
=====================================
@@ -1,3 +1,8 @@
 ---
 include:
   - 
https://salsa.debian.org/salsa-ci-team/pipeline/raw/master/recipes/debian.yml
+
+variables:
+  SALSA_CI_DISABLE_CROSSBUILD_ARM64: 0
+  SALSA_CI_ENABLE_BUILD_PACKAGE_PROFILES: 1
+  BUILD_PROFILES: nodoc


=====================================
debian/weston-doc.install
=====================================
@@ -0,0 +1 @@
+usr/share/doc



View it on GitLab: 
https://salsa.debian.org/xorg-team/wayland/weston/-/commit/116ac817dc121e881ab4ddd4a26373801100e23e

-- 
View it on GitLab: 
https://salsa.debian.org/xorg-team/wayland/weston/-/commit/116ac817dc121e881ab4ddd4a26373801100e23e
You're receiving this email because of your account on salsa.debian.org.


Reply via email to