From 213eca30743f92a51e2c44d0802f162aead0945c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Commaille?= Date: Wed, 3 Jul 2024 12:34:45 +0200 Subject: [PATCH] ci: Do not depend on rust nightly for docs generation The rust-nightly Flatpak SDK extension is deprecated, and my attempts to bundle it in a Flatpak manifest have failed. This removes a few nice features like the index page, or types linking to their docs in the corresponding crate's docs. --- .gitlab-ci/publish_docs.yml | 4 ---- README.md | 2 +- src/meson.build | 23 +++++++++++++---------- 3 files changed, 14 insertions(+), 15 deletions(-) diff --git a/.gitlab-ci/publish_docs.yml b/.gitlab-ci/publish_docs.yml index 2c68b78e..8f42a4d6 100644 --- a/.gitlab-ci/publish_docs.yml +++ b/.gitlab-ci/publish_docs.yml @@ -6,10 +6,6 @@ pages: tags: - flatpak script: - - flatpak install --user --noninteractive org.freedesktop.Sdk.Extension.rust-nightly//23.08 - # We want to use rust-nightly to build the app, but mold is in rust-stable - - sed -i 's|"org.freedesktop.Sdk.Extension.rust-stable"|"org.freedesktop.Sdk.Extension.rust-stable","org.freedesktop.Sdk.Extension.rust-nightly"|g' ${MANIFEST_PATH} - - sed -i 's|:/usr/lib/sdk/rust-stable/bin|:/usr/lib/sdk/rust-nightly/bin|g' ${MANIFEST_PATH} - flatpak-builder --keep-build-dirs --user --disable-rofiles-fuse --stop-at=${FLATPAK_MODULE} flatpak_app --repo=repo ${BRANCH:+--default-branch=$BRANCH} ${MANIFEST_PATH} - echo "ninja src/doc" | flatpak-builder --disable-rofiles-fuse --build-shell=${FLATPAK_MODULE} flatpak_app ${MANIFEST_PATH} - mv .flatpak-builder/build/${FLATPAK_MODULE}/_flatpak_build/src/doc public diff --git a/README.md b/README.md index 4728eeac..fd389184 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ [![Our chat room](https://img.shields.io/matrix/fractal-gtk:matrix.org?color=blue&label=%23fractal%3Agnome.org&logo=matrix)](https://matrix.to/#/#fractal:gnome.org) [![Our Gitlab project](https://img.shields.io/badge/gitlab.gnome.org%2F-World%2FFractal-green?logo=gitlab)](https://gitlab.gnome.org/World/fractal/) -[![Our documentation](https://img.shields.io/badge/%F0%9F%95%AE-Docs-B7410E?logo=rust)](https://world.pages.gitlab.gnome.org/fractal/) +[![Our documentation](https://img.shields.io/badge/%F0%9F%95%AE-Docs-B7410E?logo=rust)](https://world.pages.gitlab.gnome.org/fractal/fractal/index.html) [![Official package](https://img.shields.io/flathub/downloads/org.gnome.Fractal?logo=flathub)](https://flathub.org/apps/org.gnome.Fractal) # Fractal diff --git a/src/meson.build b/src/meson.build index c589d51a..93cc9acb 100644 --- a/src/meson.build +++ b/src/meson.build @@ -66,15 +66,15 @@ custom_target( ) rustdoc_flags = ' '.join([ - '-Zunstable-options', - '--enable-index-page', - '--extern-html-root-url=gio=https://gtk-rs.org/gtk-rs-core/stable/latest/docs/', - '--extern-html-root-url=glib=https://gtk-rs.org/gtk-rs-core/stable/latest/docs/', - '--extern-html-root-url=gsk4=https://gtk-rs.org/gtk4-rs/stable/latest/docs/', - '--extern-html-root-url=gdk4=https://gtk-rs.org/gtk4-rs/stable/latest/docs/', - '--extern-html-root-url=gtk4=https://gtk-rs.org/gtk4-rs/stable/latest/docs/', - '--extern-html-root-url=libadwaita=https://world.pages.gitlab.gnome.org/Rust/libadwaita-rs/stable/latest/docs/', - '--cfg=docsrs', +# FIXME: Unstable features are disabled because we need Rust nightly +# '-Zunstable-options', +# '--enable-index-page', +# '--extern-html-root-url=gio=https://gtk-rs.org/gtk-rs-core/stable/latest/docs/', +# '--extern-html-root-url=glib=https://gtk-rs.org/gtk-rs-core/stable/latest/docs/', +# '--extern-html-root-url=gsk4=https://gtk-rs.org/gtk4-rs/stable/latest/docs/', +# '--extern-html-root-url=gdk4=https://gtk-rs.org/gtk4-rs/stable/latest/docs/', +# '--extern-html-root-url=gtk4=https://gtk-rs.org/gtk4-rs/stable/latest/docs/', +# '--extern-html-root-url=libadwaita=https://world.pages.gitlab.gnome.org/Rust/libadwaita-rs/stable/latest/docs/', '-Dwarnings', ]) doc_env = ['RUSTDOCFLAGS=' + rustdoc_flags ] @@ -103,6 +103,9 @@ custom_target( command: [ 'env', cargo_env + doc_env, cargo, 'doc', - cargo_options + doc_deps + ['--no-deps', '-Zrustdoc-map'] , + cargo_options + doc_deps + [ + '--no-deps', + #'-Zrustdoc-map' + ] , ], )