Skip to content

Commit d897a45

Browse files
committed
Add documentation links for subcrates
1 parent 9b78890 commit d897a45

File tree

27 files changed

+27
-4
lines changed

27 files changed

+27
-4
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ edition = "2018"
3333
exclude = ["/svd_files"]
3434
repository = "https://github.com/drone-os/drone-stm32-map"
3535
homepage = "https://www.drone-os.com/"
36-
documentation = "https://api.drone-os.com/drone-stm32-map/0.10"
36+
documentation = "https://api.drone-os.com/drone-stm32-map/0.10/drone_stm32_map/"
3737
readme = "README.md"
3838
license = "MIT OR Apache-2.0"
3939
keywords = [

Justfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ readme:
5555
# Bump crate versions
5656
version-bump version drone-core-version drone-cortex-m-version:
5757
sed -i "s/\(api\.drone-os\.com\/drone-stm32-map\/\)[0-9]\+\(\.[0-9]\+\)\+/\1$(echo {{version}} | sed 's/\(.*\)\.[0-9]\+/\1/')/" \
58-
Cargo.toml src/lib.rs
58+
Cargo.toml src/pieces/*/Cargo.toml src/pieces/Cargo.toml src/periph/*/Cargo.toml svd/Cargo.toml src/lib.rs
5959
sed -i '/\[.*\]/h;/version = ".*"/{x;s/\[package\]/version = "{{version}}"/;t;x}' \
6060
Cargo.toml src/pieces/*/Cargo.toml src/pieces/Cargo.toml src/periph/*/Cargo.toml svd/Cargo.toml
6161
sed -i '/\[.*\]/h;/version = "=.*"/{x;s/\[.*drone-stm32-map-.*\]/version = "={{version}}"/;t;x}' \

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ model.
4343
## Documentation
4444

4545
- [Drone Book](https://book.drone-os.com/)
46-
- [API documentation](https://api.drone-os.com/drone-stm32-map/0.10)
46+
- [API documentation](https://api.drone-os.com/drone-stm32-map/0.10/)
4747

4848
The API documentation intentionally skips auto-generated [`reg`] and [`thr`]
4949
bindings. Otherwise it would use several gigabytes of space and would be

src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
//! # Documentation
3939
//!
4040
//! - [Drone Book](https://book.drone-os.com/)
41-
//! - [API documentation](https://api.drone-os.com/drone-stm32-map/0.10)
41+
//! - [API documentation](https://api.drone-os.com/drone-stm32-map/0.10/)
4242
//!
4343
//! The API documentation intentionally skips auto-generated [`reg`] and [`thr`]
4444
//! bindings. Otherwise it would use several gigabytes of space and would be

src/periph/adc/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ authors = ["Valentine Valyaeff <[email protected]>"]
55
edition = "2018"
66
repository = "https://github.com/drone-os/drone-stm32-map"
77
homepage = "https://www.drone-os.com/"
8+
documentation = "https://api.drone-os.com/drone-stm32-map/0.10/drone_stm32_map_periph_adc/"
89
license = "MIT OR Apache-2.0"
910
description = """
1011
STM32 peripheral mappings for Drone, an Embedded Operating System.

src/periph/dma/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ authors = ["Valentine Valyaeff <[email protected]>"]
55
edition = "2018"
66
repository = "https://github.com/drone-os/drone-stm32-map"
77
homepage = "https://www.drone-os.com/"
8+
documentation = "https://api.drone-os.com/drone-stm32-map/0.10/drone_stm32_map_periph_dma/"
89
license = "MIT OR Apache-2.0"
910
description = """
1011
STM32 peripheral mappings for Drone, an Embedded Operating System.

src/periph/exti/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ authors = ["Valentine Valyaeff <[email protected]>"]
55
edition = "2018"
66
repository = "https://github.com/drone-os/drone-stm32-map"
77
homepage = "https://www.drone-os.com/"
8+
documentation = "https://api.drone-os.com/drone-stm32-map/0.10/drone_stm32_map_periph_exti/"
89
license = "MIT OR Apache-2.0"
910
description = """
1011
STM32 peripheral mappings for Drone, an Embedded Operating System.

src/periph/gpio/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ authors = ["Valentine Valyaeff <[email protected]>"]
55
edition = "2018"
66
repository = "https://github.com/drone-os/drone-stm32-map"
77
homepage = "https://www.drone-os.com/"
8+
documentation = "https://api.drone-os.com/drone-stm32-map/0.10/drone_stm32_map_periph_gpio/"
89
license = "MIT OR Apache-2.0"
910
description = """
1011
STM32 peripheral mappings for Drone, an Embedded Operating System.

src/periph/i2c/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ authors = ["Valentine Valyaeff <[email protected]>"]
55
edition = "2018"
66
repository = "https://github.com/drone-os/drone-stm32-map"
77
homepage = "https://www.drone-os.com/"
8+
documentation = "https://api.drone-os.com/drone-stm32-map/0.10/drone_stm32_map_periph_i2c/"
89
license = "MIT OR Apache-2.0"
910
description = """
1011
STM32 peripheral mappings for Drone, an Embedded Operating System.

src/periph/rtc/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ authors = ["Valentine Valyaeff <[email protected]>"]
55
edition = "2018"
66
repository = "https://github.com/drone-os/drone-stm32-map"
77
homepage = "https://www.drone-os.com/"
8+
documentation = "https://api.drone-os.com/drone-stm32-map/0.10/drone_stm32_map_periph_rtc/"
89
license = "MIT OR Apache-2.0"
910
description = """
1011
STM32 peripheral mappings for Drone, an Embedded Operating System.

0 commit comments

Comments
 (0)