docs: Generate docs for ruma and matrix-sdk
Also make links between crates work. Closes #1012
This commit is contained in:
parent
99959e4a47
commit
1858eac558
|
@ -1,2 +1,5 @@
|
||||||
[build]
|
[build]
|
||||||
rustflags = ["--cfg", "ruma_identifiers_storage=\"Arc\""]
|
rustflags = ["--cfg", "ruma_identifiers_storage=\"Arc\""]
|
||||||
|
|
||||||
|
[doc.extern-map.registries]
|
||||||
|
crates-io = "https://docs.rs/"
|
||||||
|
|
|
@ -137,17 +137,6 @@ pages:
|
||||||
stage: doc
|
stage: doc
|
||||||
tags:
|
tags:
|
||||||
- flatpak
|
- 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:
|
script:
|
||||||
- flatpak-builder --keep-build-dirs --user --disable-rofiles-fuse --stop-at=${FLATPAK_MODULE} flatpak_app --repo=repo ${BRANCH:+--default-branch=$BRANCH} ${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}
|
- echo "ninja src/doc" | flatpak-builder --disable-rofiles-fuse --build-shell=${FLATPAK_MODULE} flatpak_app ${MANIFEST_PATH}
|
||||||
|
|
|
@ -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 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 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
|
# Fractal
|
||||||
|
|
||||||
|
|
|
@ -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 = custom_target(
|
||||||
'cargo-doc',
|
'cargo-doc',
|
||||||
build_by_default: false,
|
build_by_default: false,
|
||||||
|
@ -58,8 +84,8 @@ cargo_doc = custom_target(
|
||||||
output: 'doc',
|
output: 'doc',
|
||||||
console: true,
|
console: true,
|
||||||
command: [
|
command: [
|
||||||
'env', cargo_env,
|
'env', cargo_env + doc_env,
|
||||||
cargo, 'doc',
|
cargo, 'doc',
|
||||||
cargo_options + ['--no-deps', '--document-private-items'],
|
cargo_options + doc_deps + ['--no-deps', '--document-private-items', '-Zrustdoc-map'] ,
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
|
|
Loading…
Reference in New Issue