doc: fix ci upload & broken links

This commit is contained in:
Victor Berger 2021-06-11 17:46:32 +02:00
parent 9ad0edd2a3
commit 41c7b22cc4
5 changed files with 7 additions and 8 deletions

View File

@ -33,7 +33,7 @@ jobs:
uses: actions-rs/cargo@v1 uses: actions-rs/cargo@v1
with: with:
command: doc command: doc
args: --no-deps --features "test_all_features" -p smithay -p calloop:0.6.2 -p dbus -p drm -p gbm -p image -p input -p nix:0.17.0 -p udev -p slog -p wayland-server -p wayland-commons:0.26.6 -p wayland-protocols:0.26.6 -p winit args: --no-deps --features "test_all_features" -p smithay -p calloop:0.8.0 -p dbus -p drm -p gbm -p input -p nix:0.20.0 -p udev -p slog -p wayland-server -p wayland-commons -p wayland-protocols -p winit
- name: Setup index - name: Setup index
run: cp ./doc_index.html ./target/doc/index.html run: cp ./doc_index.html ./target/doc/index.html

View File

@ -47,7 +47,7 @@ gl_generator = { version = "0.14", optional = true }
pkg-config = { version = "0.3.17", optional = true } pkg-config = { version = "0.3.17", optional = true }
[features] [features]
default = ["backend_drm", "backend_gbm", "backend_libinput", "backend_udev", "backend_session_logind", "backend_winit", "renderer_gl", "xwayland", "wayland_frontend", "slog-stdlog"] default = ["backend_drm", "backend_gbm", "backend_libinput", "backend_udev", "backend_session_logind", "backend_winit", "image", "renderer_gl", "xwayland", "wayland_frontend", "slog-stdlog"]
backend_winit = ["winit", "wayland-server/dlopen", "backend_egl", "wayland-egl", "renderer_gl"] backend_winit = ["winit", "wayland-server/dlopen", "backend_egl", "wayland-egl", "renderer_gl"]
backend_drm = ["drm", "drm-ffi"] backend_drm = ["drm", "drm-ffi"]
backend_gbm = ["gbm"] backend_gbm = ["gbm"]

View File

@ -266,7 +266,7 @@ where
} }
/// Returns the pending [`connector`](drm::control::connector)s /// Returns the pending [`connector`](drm::control::connector)s
/// used for the next frame as submitted by [`finish`](Renderer::finish) of this [`DrmRenderSurface`] /// used for the next frame in [`render`](DrmRenderSurface::render)
pub fn pending_connectors(&self) -> impl IntoIterator<Item = connector::Handle> { pub fn pending_connectors(&self) -> impl IntoIterator<Item = connector::Handle> {
self.drm.pending_connectors() self.drm.pending_connectors()
} }

View File

@ -198,8 +198,8 @@ impl<A: AsRawFd + 'static> DrmSurface<A> {
/// ///
/// This operation is not necessarily blocking until the crtc is in the desired state, /// This operation is not necessarily blocking until the crtc is in the desired state,
/// but will trigger a `vblank` event once done. /// but will trigger a `vblank` event once done.
/// Make sure to [set a `DeviceHandler`](crate::backend::drm::DrmDevice::set_handler) and /// Make sure to have the device registered in your event loop prior to invoking this, to not miss
/// [register the belonging `Device`](crate::backend::drm::device_bind) before to receive the event in time. /// any generated event.
pub fn commit<'a>( pub fn commit<'a>(
&self, &self,
mut framebuffers: impl Iterator<Item = &'a (framebuffer::Handle, plane::Handle)>, mut framebuffers: impl Iterator<Item = &'a (framebuffer::Handle, plane::Handle)>,
@ -226,8 +226,7 @@ impl<A: AsRawFd + 'static> DrmSurface<A> {
/// This will not cause the crtc to modeset. /// This will not cause the crtc to modeset.
/// ///
/// This operation is not blocking and will produce a `vblank` event once swapping is done. /// This operation is not blocking and will produce a `vblank` event once swapping is done.
/// Make sure to [set a `DeviceHandler`](crate::backend::drm::DrmDevice::set_handler) and /// Make sure to have the device registered in your event loop to not miss the event.
/// [register the belonging `DrmDevice`](crate::backend::drm::device_bind) before to receive the event in time.
pub fn page_flip<'a>( pub fn page_flip<'a>(
&self, &self,
mut framebuffers: impl Iterator<Item = &'a (framebuffer::Handle, plane::Handle)>, mut framebuffers: impl Iterator<Item = &'a (framebuffer::Handle, plane::Handle)>,

View File

@ -13,7 +13,7 @@
//! //!
//! The list of supported format is just a `Vec<Format>`, where you will enter all the (code, modifier) //! The list of supported format is just a `Vec<Format>`, where you will enter all the (code, modifier)
//! couples you support. You can typically receive a list of supported formats for one renderer by calling //! couples you support. You can typically receive a list of supported formats for one renderer by calling
//! [`crate::backend::renderer::Renderer::dmabuf_formats`]. //! [`crate::backend::renderer::ImportDma::dmabuf_formats`].
//! //!
//! ``` //! ```
//! # extern crate wayland_server; //! # extern crate wayland_server;