nordic-dev.net/rust-gpu
2
0
Fork 0
mirror of https://github.com/EmbarkStudios/rust-gpu.git synced 2024-11-21 22:34:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Some tweaks to docs

Browse Source
This commit is contained in:
Sylvester Hesp 2022-12-19 17:09:20 +01:00
parent 8bf791d0c4
commit ecceedab92
12 changed files with 12 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
crates/rustc_codegen_spirv-types/Cargo.toml
View File

@ -1,7 +1,6 @@
[package]
name = "rustc_codegen_spirv-types"
description = "SPIR-V backend types shared between rustc_codegen_spirv and spirv-builder"
documentation = "https://embarkstudios.github.io/rust-gpu/api/rustc_codegen_spirv_types/index.html"
version.workspace = true
authors.workspace = true
edition.workspace = true

2
crates/rustc_codegen_spirv-types/README.md
View File

@ -1,3 +1,3 @@
# `rustc_codegen_spirv-types`
SPIR-V backend types shared between `rustc_codegen_spirv` and `spirv-builder`. Please refer to [`spirv-builder`](https://crates.io/crates/spirv-builder) for more information.
SPIR-V backend types shared between `rustc_codegen_spirv` and `spirv-builder`. Please refer to [`spirv-builder`](https://docs.rs/spirv-builder/) for more information.

2
crates/rustc_codegen_spirv-types/src/lib.rs
View File

@ -1,4 +1,4 @@
//! Types used by both `rustc_codegen_spirv` and `spirv-builder`.
#![doc = include_str!("../README.md")]
pub use rspirv::spirv::Capability;

2
crates/rustc_codegen_spirv/README.md
View File

@ -1,6 +1,6 @@
# `rustc_codegen_spirv`
Compiler backend for the `SPIR-V` target architecture. This crate is not intended to be used directly. Please refer to [`spirv-builder`](https://crates.io/crates/spirv-builder) for more information.
Compiler backend for the `SPIR-V` target architecture. This crate is not intended to be used directly. Please refer to [`spirv-builder`](https://docs.rs/spirv-builder/) for more information.
## Documentation

4
crates/spirv-builder/README.md
View File

@ -2,7 +2,7 @@
<!-- markdownlint-disable-file MD033 -->
# `spirv-builder`
![Rust version](https://img.shields.io/badge/rust-1.66.0_nightly--2022--10--29-purple.svg)
![Rust version](https://img.shields.io/badge/rust-nightly--2022--10--29-purple.svg)
This crate gives you `SpirvBuilder`, a tool to build shaders using [rust-gpu][rustgpu].
@ -36,7 +36,7 @@ Because of its nature, `rustc_codegen_spirv`, and therefore `spirv-builder` by e
Toolchains for previous versions of `spirv-builder`:
|Version|Toolchain|
|-|-|
|-:|-|
|`0.4.0`|`nightly-2022-10-29`|
|`0.4.0-alpha.16` - `0.4.0-alpha.17`|`nightly-2022-10-01`|
|`0.4.0-alpha.15`|`nightly-2022-08-29`|

1
crates/spirv-builder/src/lib.rs
View File

@ -69,6 +69,7 @@
// END - Embark standard lints v0.4
// crate-specific exceptions:
// #![allow()]
#![doc = include_str!("../README.md")]
mod depfile;
#[cfg(feature = "watch")]

2
crates/spirv-std/README.md
View File

@ -6,7 +6,7 @@ This crate gives a `rust-gpu` shader access to the required `#![spirv(..)]` attr
## 🚨 BREAKING 🚨
As of `0.4.0-alpha.16`, your shaders will require a different preamble. See [this doc][migration] for more information.
As of `0.4.0-alpha.16`, your shaders will require a different preamble. See [this migration guide][migration] for more information.
## Example

2
crates/spirv-std/macros/README.md
View File

@ -1,3 +1,3 @@
# `spirv-std-macros`
This crate implements macros required for `spirv-std`. Most importantly, it implements the `#![spirv(..)]` attribute macro required for use in shader code. Please refer to [`spirv-std`](https://crates.io/crates/spirv-std) for more information.
This crate implements macros required for `spirv-std`. Most importantly, it implements the `#![spirv(..)]` attribute macro required for use in shader code. Please refer to [`spirv-std`](https://docs.rs/spirv-std/) for more information.

1
crates/spirv-std/macros/src/lib.rs
View File

@ -69,6 +69,7 @@
// END - Embark standard lints v0.4
// crate-specific exceptions:
// #![allow()]
#![doc = include_str!("../README.md")]
mod image;

2
crates/spirv-std/shared/README.md
View File

@ -1,3 +1,3 @@
# `spirv-std-types`
Small shared crate, to share definitions between [`spirv-std`](https://crates.io/crates/spirv-std) and [`spirv-std-macros`](https://crates.io/crates/spirv-std-macros). Please refer to [`spirv-std`](https://crates.io/crates/spirv-std) for more information.
Small shared crate, to share definitions between [`spirv-std`](https://docs.rs/spirv-std/) and [`spirv-std-macros`](https://docs.rs/spirv-std-macros/). Please refer to [`spirv-std`](https://docs.rs/spirv-std/) for more information.

4
crates/spirv-std/shared/src/lib.rs
View File

@ -1,6 +1,4 @@
//! Small shared crate, to share definitions between `spirv-std`
//! and `spirv-std-macros`.
#![doc = include_str!("../README.md")]
#![no_std]
pub mod image_params;

4
crates/spirv-std/src/lib.rs
View File

@ -87,9 +87,7 @@
clippy::unimplemented,
)]
#![warn(missing_docs)]
//! Core functions, traits, and more that make up a "standard library" for SPIR-V for use in
//! rust-gpu.
#![doc = include_str!("../README.md")]
#[macro_use]
pub extern crate spirv_std_macros as macros;