diff --git a/.cargo/config.toml b/.cargo/config.toml index 64d43966..c07abad2 100644 --- a/.cargo/config.toml +++ b/.cargo/config.toml @@ -1,2 +1,5 @@ [build] rustflags = ["--cfg", "ruma_identifiers_storage=\"Arc\""] + +[doc.extern-map.registries] +crates-io = "https://docs.rs/" diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index f2d68e94..394028cb 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -137,17 +137,6 @@ pages: stage: doc tags: - flatpak - variables: - RUSTDOCFLAGS: > - -Z unstable-options - --enable-index-page - --extern-html-root-url=gio=https://gtk-rs.org/gtk-rs-core/stable/latest/docs/gio/ - --extern-html-root-url=gsk4=https://gtk-rs.org/gtk4-rs/stable/latest/docs/gsk4/ - --extern-html-root-url=gdk4=https://gtk-rs.org/gtk4-rs/stable/latest/docs/gdk4/ - --extern-html-root-url=gtk4=https://gtk-rs.org/gtk4-rs/stable/latest/docs/gtk4/ - --extern-html-root-url=glib=https://gtk-rs.org/gtk-rs-core/stable/latest/docs/glib/ - --extern-html-root-url=libadwaita=https://world.pages.gitlab.gnome.org/Rust/libadwaita-rs/stable/latest/docs/libadwaita/ - --extern-html-root-url=matrix-sdk=https://matrix-org.github.io/matrix-rust-sdk/matrix_sdk script: - 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} diff --git a/README.md b/README.md index a5f89042..1f610eef 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-GNOME%2FFractal-green?logo=gitlab)](https://gitlab.gnome.org/GNOME/fractal/) -[![Our documentation](https://img.shields.io/badge/%F0%9F%95%AE-Docs-B7410E?logo=rust)](https://gnome.pages.gitlab.gnome.org/fractal/fractal/) +[![Our documentation](https://img.shields.io/badge/%F0%9F%95%AE-Docs-B7410E?logo=rust)](https://gnome.pages.gitlab.gnome.org/fractal/) # Fractal diff --git a/src/meson.build b/src/meson.build index a8e9092b..6e1597c3 100644 --- a/src/meson.build +++ b/src/meson.build @@ -51,6 +51,32 @@ cargo_build = 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', +]) +doc_env = ['RUSTDOCFLAGS=' + rustdoc_flags ] +doc_deps = [ + '--package=ruma', + '--package=ruma-common', + '--package=ruma-client-api', + '--package=matrix-sdk', + '--package=matrix-sdk-base', + '--package=matrix-sdk-common', + '--package=matrix-sdk-crypto', + '--package=matrix-qrcode', + '--package=matrix-sdk-sled', + '--package=matrix-sdk-store-encryption', + '--package=fractal', +] + cargo_doc = custom_target( 'cargo-doc', build_by_default: false, @@ -58,8 +84,8 @@ cargo_doc = custom_target( output: 'doc', console: true, command: [ - 'env', cargo_env, + 'env', cargo_env + doc_env, cargo, 'doc', - cargo_options + ['--no-deps', '--document-private-items'], + cargo_options + doc_deps + ['--no-deps', '--document-private-items', '-Zrustdoc-map'] , ], )