From e4271b82b2916deecfe48f273d3df644599b991c Mon Sep 17 00:00:00 2001 From: Sebastian Wick Date: Thu, 9 Oct 2025 18:06:39 +0200 Subject: [PATCH] doc: Build libflatpak-doc.html Closes #4591 (cherry picked from commit 815301f3410499fb8c6f85ea0f99a9adc1c28487) --- .github/workflows/check.yml | 11 ++++++++++- doc/reference/meson.build | 25 ++++++++++++++++++++++++- 2 files changed, 34 insertions(+), 2 deletions(-) diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index fb10e517..9d42f235 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -188,7 +188,8 @@ jobs: libfuse-dev ostree libostree-dev libarchive-dev libzstd-dev libcap-dev libattr1-dev libdw-dev libelf-dev python3-pyparsing \ libjson-glib-dev shared-mime-info desktop-file-utils libpolkit-agent-1-dev libpolkit-gobject-1-dev \ libseccomp-dev libsoup2.4-dev libcurl4-openssl-dev libsystemd-dev libxml2-utils libgpgme11-dev gobject-introspection \ - libgirepository1.0-dev libappstream-dev libdconf-dev clang e2fslibs-dev meson socat libxau-dev libgdk-pixbuf2.0-dev + libgirepository1.0-dev libappstream-dev libdconf-dev clang e2fslibs-dev meson socat libxau-dev libgdk-pixbuf2.0-dev \ + xmlto - name: Check out flatpak uses: actions/checkout@v4 with: @@ -207,6 +208,14 @@ jobs: run: ninja -C _build - name: Perform CodeQL Analysis uses: github/codeql-action/analyze@v3 + - name: Upload docs + uses: actions/upload-artifact@v4 + with: + if-no-files-found: error + overwrite: true + name: docs + path: | + _build/doc/ valgrind: name: Run tests in valgrind diff --git a/doc/reference/meson.build b/doc/reference/meson.build index a881b0cb..7369fb4d 100644 --- a/doc/reference/meson.build +++ b/doc/reference/meson.build @@ -25,7 +25,7 @@ doc_gdbus = gnome.gdbus_codegen( docbook : 'dbus', ) -gnome.gtkdoc( +libflatpak_doc = gnome.gtkdoc( 'flatpak', main_xml : 'libflatpak-docs.xml', namespace : 'flatpak', @@ -72,3 +72,26 @@ gnome.gtkdoc( '--rebuild-types', ], ) + +if xmlto.found() + custom_target( + 'libflatpak-docs.html', + input : [ + '../xmlto-config.xsl', + ], + output : ['libflatpak-docs.html'], + depends : libflatpak_doc, + command : [ + xmlto, + '-o', meson.current_build_dir(), + ] + get_option('xmlto_flags') + [ + '--skip-validation', + 'xhtml-nochunks', + '-m', '@INPUT0@', + fs.parent(libflatpak_doc.full_path()) / 'libflatpak-docs.xml', + ], + build_by_default : true, + install : true, + install_dir : docdir, + ) +endif \ No newline at end of file