Deny broken_intradoc_links and verify documentation in CI
This commit is contained in:
parent
89d9f1d7d2
commit
f60884f6f8
17 changed files with 68 additions and 33 deletions
6
.github/workflows/document.yml
vendored
6
.github/workflows/document.yml
vendored
|
|
@ -1,8 +1,5 @@
|
||||||
name: Document
|
name: Document
|
||||||
on:
|
on: [push, pull_request]
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
jobs:
|
jobs:
|
||||||
all:
|
all:
|
||||||
runs-on: ubuntu-20.04
|
runs-on: ubuntu-20.04
|
||||||
|
|
@ -31,6 +28,7 @@ jobs:
|
||||||
- name: Write CNAME file
|
- name: Write CNAME file
|
||||||
run: echo 'docs.iced.rs' > ./target/doc/CNAME
|
run: echo 'docs.iced.rs' > ./target/doc/CNAME
|
||||||
- name: Publish documentation
|
- name: Publish documentation
|
||||||
|
if: github.ref == 'refs/heads/master'
|
||||||
uses: peaceiris/actions-gh-pages@v3
|
uses: peaceiris/actions-gh-pages@v3
|
||||||
with:
|
with:
|
||||||
deploy_key: ${{ secrets.DOCS_DEPLOY_KEY }}
|
deploy_key: ${{ secrets.DOCS_DEPLOY_KEY }}
|
||||||
|
|
|
||||||
|
|
@ -9,6 +9,7 @@
|
||||||
#![doc(
|
#![doc(
|
||||||
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
|
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
|
||||||
)]
|
)]
|
||||||
|
#![forbid(unsafe_code, rust_2018_idioms)]
|
||||||
#![deny(
|
#![deny(
|
||||||
missing_debug_implementations,
|
missing_debug_implementations,
|
||||||
missing_docs,
|
missing_docs,
|
||||||
|
|
@ -17,9 +18,9 @@
|
||||||
clippy::from_over_into,
|
clippy::from_over_into,
|
||||||
clippy::needless_borrow,
|
clippy::needless_borrow,
|
||||||
clippy::new_without_default,
|
clippy::new_without_default,
|
||||||
clippy::useless_conversion
|
clippy::useless_conversion,
|
||||||
|
rustdoc::broken_intra_doc_links
|
||||||
)]
|
)]
|
||||||
#![forbid(unsafe_code, rust_2018_idioms)]
|
|
||||||
#![allow(clippy::inherent_to_string, clippy::type_complexity)]
|
#![allow(clippy::inherent_to_string, clippy::type_complexity)]
|
||||||
pub mod alignment;
|
pub mod alignment;
|
||||||
pub mod clipboard;
|
pub mod clipboard;
|
||||||
|
|
|
||||||
|
|
@ -4,6 +4,7 @@
|
||||||
#![doc(
|
#![doc(
|
||||||
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
|
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
|
||||||
)]
|
)]
|
||||||
|
#![forbid(unsafe_code, rust_2018_idioms)]
|
||||||
#![deny(
|
#![deny(
|
||||||
missing_debug_implementations,
|
missing_debug_implementations,
|
||||||
missing_docs,
|
missing_docs,
|
||||||
|
|
@ -12,9 +13,9 @@
|
||||||
clippy::from_over_into,
|
clippy::from_over_into,
|
||||||
clippy::needless_borrow,
|
clippy::needless_borrow,
|
||||||
clippy::new_without_default,
|
clippy::new_without_default,
|
||||||
clippy::useless_conversion
|
clippy::useless_conversion,
|
||||||
|
rustdoc::broken_intra_doc_links
|
||||||
)]
|
)]
|
||||||
#![forbid(unsafe_code, rust_2018_idioms)]
|
|
||||||
#![allow(clippy::inherent_to_string, clippy::type_complexity)]
|
#![allow(clippy::inherent_to_string, clippy::type_complexity)]
|
||||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||||
pub use futures;
|
pub use futures;
|
||||||
|
|
|
||||||
|
|
@ -7,6 +7,7 @@
|
||||||
#![doc(
|
#![doc(
|
||||||
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
|
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
|
||||||
)]
|
)]
|
||||||
|
#![forbid(rust_2018_idioms)]
|
||||||
#![deny(
|
#![deny(
|
||||||
missing_debug_implementations,
|
missing_debug_implementations,
|
||||||
missing_docs,
|
missing_docs,
|
||||||
|
|
@ -16,9 +17,9 @@
|
||||||
clippy::from_over_into,
|
clippy::from_over_into,
|
||||||
clippy::needless_borrow,
|
clippy::needless_borrow,
|
||||||
clippy::new_without_default,
|
clippy::new_without_default,
|
||||||
clippy::useless_conversion
|
clippy::useless_conversion,
|
||||||
|
rustdoc::broken_intra_doc_links
|
||||||
)]
|
)]
|
||||||
#![forbid(rust_2018_idioms)]
|
|
||||||
#![allow(clippy::inherent_to_string, clippy::type_complexity)]
|
#![allow(clippy::inherent_to_string, clippy::type_complexity)]
|
||||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||||
mod antialiasing;
|
mod antialiasing;
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,16 @@
|
||||||
|
#![forbid(rust_2018_idioms)]
|
||||||
|
#![deny(
|
||||||
|
unsafe_code,
|
||||||
|
unused_results,
|
||||||
|
clippy::extra_unused_lifetimes,
|
||||||
|
clippy::from_over_into,
|
||||||
|
clippy::needless_borrow,
|
||||||
|
clippy::new_without_default,
|
||||||
|
clippy::useless_conversion,
|
||||||
|
rustdoc::broken_intra_doc_links
|
||||||
|
)]
|
||||||
|
#![allow(clippy::inherent_to_string, clippy::type_complexity)]
|
||||||
|
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||||
pub mod compositor;
|
pub mod compositor;
|
||||||
|
|
||||||
#[cfg(feature = "geometry")]
|
#[cfg(feature = "geometry")]
|
||||||
|
|
|
||||||
|
|
@ -8,6 +8,7 @@
|
||||||
#![doc(
|
#![doc(
|
||||||
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
|
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
|
||||||
)]
|
)]
|
||||||
|
#![forbid(unsafe_code, rust_2018_idioms)]
|
||||||
#![deny(
|
#![deny(
|
||||||
missing_debug_implementations,
|
missing_debug_implementations,
|
||||||
missing_docs,
|
missing_docs,
|
||||||
|
|
@ -16,9 +17,9 @@
|
||||||
clippy::from_over_into,
|
clippy::from_over_into,
|
||||||
clippy::needless_borrow,
|
clippy::needless_borrow,
|
||||||
clippy::new_without_default,
|
clippy::new_without_default,
|
||||||
clippy::useless_conversion
|
clippy::useless_conversion,
|
||||||
|
rustdoc::broken_intra_doc_links
|
||||||
)]
|
)]
|
||||||
#![forbid(unsafe_code, rust_2018_idioms)]
|
|
||||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||||
pub mod clipboard;
|
pub mod clipboard;
|
||||||
pub mod command;
|
pub mod command;
|
||||||
|
|
|
||||||
|
|
@ -151,6 +151,7 @@
|
||||||
#![doc(
|
#![doc(
|
||||||
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
|
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
|
||||||
)]
|
)]
|
||||||
|
#![forbid(rust_2018_idioms, unsafe_code)]
|
||||||
#![deny(
|
#![deny(
|
||||||
missing_debug_implementations,
|
missing_debug_implementations,
|
||||||
missing_docs,
|
missing_docs,
|
||||||
|
|
@ -159,9 +160,9 @@
|
||||||
clippy::from_over_into,
|
clippy::from_over_into,
|
||||||
clippy::needless_borrow,
|
clippy::needless_borrow,
|
||||||
clippy::new_without_default,
|
clippy::new_without_default,
|
||||||
clippy::useless_conversion
|
clippy::useless_conversion,
|
||||||
|
rustdoc::broken_intra_doc_links
|
||||||
)]
|
)]
|
||||||
#![forbid(rust_2018_idioms, unsafe_code)]
|
|
||||||
#![allow(clippy::inherent_to_string, clippy::type_complexity)]
|
#![allow(clippy::inherent_to_string, clippy::type_complexity)]
|
||||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||||
use iced_widget::graphics;
|
use iced_widget::graphics;
|
||||||
|
|
|
||||||
|
|
@ -7,16 +7,18 @@
|
||||||
#![doc(
|
#![doc(
|
||||||
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
|
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
|
||||||
)]
|
)]
|
||||||
|
#![forbid(unsafe_code, rust_2018_idioms)]
|
||||||
#![deny(
|
#![deny(
|
||||||
unused_results,
|
unused_results,
|
||||||
clippy::extra_unused_lifetimes,
|
clippy::extra_unused_lifetimes,
|
||||||
clippy::from_over_into,
|
clippy::from_over_into,
|
||||||
clippy::needless_borrow,
|
clippy::needless_borrow,
|
||||||
clippy::new_without_default,
|
clippy::new_without_default,
|
||||||
clippy::useless_conversion
|
clippy::useless_conversion,
|
||||||
|
missing_docs,
|
||||||
|
unused_results,
|
||||||
|
rustdoc::broken_intra_doc_links
|
||||||
)]
|
)]
|
||||||
#![deny(missing_docs, unused_results)]
|
|
||||||
#![forbid(unsafe_code, rust_2018_idioms)]
|
|
||||||
#![allow(clippy::inherent_to_string, clippy::type_complexity)]
|
#![allow(clippy::inherent_to_string, clippy::type_complexity)]
|
||||||
pub use iced_core as core;
|
pub use iced_core as core;
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -303,7 +303,7 @@ pub fn into_fill_rule(rule: fill::Rule) -> tiny_skia::FillRule {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn into_stroke(stroke: &Stroke) -> tiny_skia::Stroke {
|
pub fn into_stroke(stroke: &Stroke<'_>) -> tiny_skia::Stroke {
|
||||||
tiny_skia::Stroke {
|
tiny_skia::Stroke {
|
||||||
width: stroke.width,
|
width: stroke.width,
|
||||||
line_cap: match stroke.line_cap {
|
line_cap: match stroke.line_cap {
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,16 @@
|
||||||
|
#![forbid(rust_2018_idioms)]
|
||||||
|
#![deny(
|
||||||
|
unsafe_code,
|
||||||
|
unused_results,
|
||||||
|
clippy::extra_unused_lifetimes,
|
||||||
|
clippy::from_over_into,
|
||||||
|
clippy::needless_borrow,
|
||||||
|
clippy::new_without_default,
|
||||||
|
clippy::useless_conversion,
|
||||||
|
rustdoc::broken_intra_doc_links
|
||||||
|
)]
|
||||||
|
#![allow(clippy::inherent_to_string, clippy::type_complexity)]
|
||||||
|
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||||
pub mod window;
|
pub mod window;
|
||||||
|
|
||||||
mod backend;
|
mod backend;
|
||||||
|
|
|
||||||
|
|
@ -85,14 +85,14 @@ impl Cache {
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
entry.insert(Some(Entry {
|
let _ = entry.insert(Some(Entry {
|
||||||
width: image.width(),
|
width: image.width(),
|
||||||
height: image.height(),
|
height: image.height(),
|
||||||
pixels: buffer,
|
pixels: buffer,
|
||||||
}));
|
}));
|
||||||
}
|
}
|
||||||
|
|
||||||
self.hits.insert(id);
|
let _ = self.hits.insert(id);
|
||||||
self.entries.get(&id).unwrap().as_ref().map(|entry| {
|
self.entries.get(&id).unwrap().as_ref().map(|entry| {
|
||||||
tiny_skia::PixmapRef::from_bytes(
|
tiny_skia::PixmapRef::from_bytes(
|
||||||
bytemuck::cast_slice(&entry.pixels),
|
bytemuck::cast_slice(&entry.pixels),
|
||||||
|
|
|
||||||
|
|
@ -32,7 +32,7 @@ impl Pipeline {
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn load_font(&mut self, bytes: Cow<'static, [u8]>) {
|
pub fn load_font(&mut self, bytes: Cow<'static, [u8]>) {
|
||||||
self.font_system.get_mut().db_mut().load_font_source(
|
let _ = self.font_system.get_mut().db_mut().load_font_source(
|
||||||
cosmic_text::fontdb::Source::Binary(Arc::new(bytes.into_owned())),
|
cosmic_text::fontdb::Source::Binary(Arc::new(bytes.into_owned())),
|
||||||
);
|
);
|
||||||
|
|
||||||
|
|
@ -335,10 +335,10 @@ impl GlyphCache {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
entry.insert((buffer, image.placement));
|
let _ = entry.insert((buffer, image.placement));
|
||||||
}
|
}
|
||||||
|
|
||||||
self.recently_used.insert(key);
|
let _ = self.recently_used.insert(key);
|
||||||
|
|
||||||
self.entries.get(&key).map(|(buffer, placement)| {
|
self.entries.get(&key).map(|(buffer, placement)| {
|
||||||
(bytemuck::cast_slice(buffer.as_slice()), *placement)
|
(bytemuck::cast_slice(buffer.as_slice()), *placement)
|
||||||
|
|
|
||||||
|
|
@ -92,10 +92,10 @@ impl Cache {
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
entry.insert(svg);
|
let _ = entry.insert(svg);
|
||||||
}
|
}
|
||||||
|
|
||||||
self.tree_hits.insert(id);
|
let _ = self.tree_hits.insert(id);
|
||||||
self.trees.get(&id).unwrap().as_ref()
|
self.trees.get(&id).unwrap().as_ref()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -178,10 +178,10 @@ impl Cache {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
self.rasters.insert(key, image);
|
let _ = self.rasters.insert(key, image);
|
||||||
}
|
}
|
||||||
|
|
||||||
self.raster_hits.insert(key);
|
let _ = self.raster_hits.insert(key);
|
||||||
self.rasters.get(&key).map(tiny_skia::Pixmap::as_ref)
|
self.rasters.get(&key).map(tiny_skia::Pixmap::as_ref)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -39,6 +39,7 @@ impl<Theme> crate::graphics::Compositor for Compositor<Theme> {
|
||||||
width: u32,
|
width: u32,
|
||||||
height: u32,
|
height: u32,
|
||||||
) -> Surface {
|
) -> Surface {
|
||||||
|
#[allow(unsafe_code)]
|
||||||
let window =
|
let window =
|
||||||
unsafe { softbuffer::GraphicsContext::new(window, window) }
|
unsafe { softbuffer::GraphicsContext::new(window, window) }
|
||||||
.expect("Create softbuffer for window");
|
.expect("Create softbuffer for window");
|
||||||
|
|
|
||||||
|
|
@ -20,6 +20,7 @@
|
||||||
#![doc(
|
#![doc(
|
||||||
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
|
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
|
||||||
)]
|
)]
|
||||||
|
#![forbid(rust_2018_idioms)]
|
||||||
#![deny(
|
#![deny(
|
||||||
missing_debug_implementations,
|
missing_debug_implementations,
|
||||||
missing_docs,
|
missing_docs,
|
||||||
|
|
@ -29,9 +30,9 @@
|
||||||
clippy::from_over_into,
|
clippy::from_over_into,
|
||||||
clippy::needless_borrow,
|
clippy::needless_borrow,
|
||||||
clippy::new_without_default,
|
clippy::new_without_default,
|
||||||
clippy::useless_conversion
|
clippy::useless_conversion,
|
||||||
|
rustdoc::broken_intra_doc_links
|
||||||
)]
|
)]
|
||||||
#![forbid(rust_2018_idioms)]
|
|
||||||
#![allow(clippy::inherent_to_string, clippy::type_complexity)]
|
#![allow(clippy::inherent_to_string, clippy::type_complexity)]
|
||||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||||
pub mod layer;
|
pub mod layer;
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,7 @@
|
||||||
#![doc(
|
#![doc(
|
||||||
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
|
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
|
||||||
)]
|
)]
|
||||||
|
#![forbid(unsafe_code, rust_2018_idioms)]
|
||||||
#![deny(
|
#![deny(
|
||||||
missing_debug_implementations,
|
missing_debug_implementations,
|
||||||
missing_docs,
|
missing_docs,
|
||||||
|
|
@ -10,9 +11,9 @@
|
||||||
clippy::from_over_into,
|
clippy::from_over_into,
|
||||||
clippy::needless_borrow,
|
clippy::needless_borrow,
|
||||||
clippy::new_without_default,
|
clippy::new_without_default,
|
||||||
clippy::useless_conversion
|
clippy::useless_conversion,
|
||||||
|
rustdoc::broken_intra_doc_links
|
||||||
)]
|
)]
|
||||||
#![forbid(unsafe_code, rust_2018_idioms)]
|
|
||||||
#![allow(clippy::inherent_to_string, clippy::type_complexity)]
|
#![allow(clippy::inherent_to_string, clippy::type_complexity)]
|
||||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||||
pub use iced_renderer as renderer;
|
pub use iced_renderer as renderer;
|
||||||
|
|
|
||||||
|
|
@ -17,6 +17,7 @@
|
||||||
#![doc(
|
#![doc(
|
||||||
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
|
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
|
||||||
)]
|
)]
|
||||||
|
#![forbid(rust_2018_idioms)]
|
||||||
#![deny(
|
#![deny(
|
||||||
missing_debug_implementations,
|
missing_debug_implementations,
|
||||||
missing_docs,
|
missing_docs,
|
||||||
|
|
@ -26,9 +27,9 @@
|
||||||
clippy::needless_borrow,
|
clippy::needless_borrow,
|
||||||
clippy::new_without_default,
|
clippy::new_without_default,
|
||||||
clippy::useless_conversion,
|
clippy::useless_conversion,
|
||||||
unsafe_code
|
unsafe_code,
|
||||||
|
rustdoc::broken_intra_doc_links
|
||||||
)]
|
)]
|
||||||
#![forbid(rust_2018_idioms)]
|
|
||||||
#![allow(clippy::inherent_to_string, clippy::type_complexity)]
|
#![allow(clippy::inherent_to_string, clippy::type_complexity)]
|
||||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||||
pub use iced_graphics as graphics;
|
pub use iced_graphics as graphics;
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue