Skip to content

Commit 9b78890

Browse files
valffvalff
committed
Fix API documentation by moving to self-hosted https://api.drone-os.com 
1 parent 6e70e3d commit 9b78890

29 files changed

+101
-168
lines changed

‎CHANGELOG.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Changelog
2+
3+
This project follows semantic versioning.
4+
5+
Possible log types:
6+
7+
- `[added]` for new features.
8+
- `[changed]` for changes in existing functionality.
9+
- `[deprecated]` for once-stable features removed in upcoming releases.
10+
- `[removed]` for deprecated features removed in this release.
11+
- `[fixed]` for any bug fixes.
12+
- `[security]` to invite users to upgrade in case of vulnerabilities.
13+
14+
### Unreleased
15+
16+
### v0.10.1 (2019-09-27)
17+
18+
- [fixed] Fix API documentation by moving to self-hosted https://api.drone-os.com

‎Cargo.toml‎

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ members = [
2727

2828
[package]
2929
name = "drone-stm32-map"
30-
version = "0.10.0"
30+
version = "0.10.1"
3131
authors = ["Valentine Valyaeff <[email protected]>"]
3232
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://docs.rs/drone-stm32-map/0.10.0"
36+
documentation = "https://api.drone-os.com/drone-stm32-map/0.10"
3737
readme = "README.md"
3838
license = "MIT OR Apache-2.0"
3939
keywords = [
@@ -243,54 +243,50 @@ version = "0.10.0"
243243
path = "../drone-cortex-m"
244244

245245
[dependencies.drone-stm32-map-pieces]
246-
version = "=0.10.0"
246+
version = "=0.10.1"
247247
path = "src/pieces"
248248

249249
[dependencies.drone-stm32-map-periph-adc]
250-
version = "=0.10.0"
250+
version = "=0.10.1"
251251
path = "src/periph/adc"
252252
optional = true
253253

254254
[dependencies.drone-stm32-map-periph-dma]
255-
version = "=0.10.0"
255+
version = "=0.10.1"
256256
path = "src/periph/dma"
257257
optional = true
258258

259259
[dependencies.drone-stm32-map-periph-exti]
260-
version = "=0.10.0"
260+
version = "=0.10.1"
261261
path = "src/periph/exti"
262262
optional = true
263263

264264
[dependencies.drone-stm32-map-periph-gpio]
265-
version = "=0.10.0"
265+
version = "=0.10.1"
266266
path = "src/periph/gpio"
267267
optional = true
268268

269269
[dependencies.drone-stm32-map-periph-i2c]
270-
version = "=0.10.0"
270+
version = "=0.10.1"
271271
path = "src/periph/i2c"
272272
optional = true
273273

274274
[dependencies.drone-stm32-map-periph-rtc]
275-
version = "=0.10.0"
275+
version = "=0.10.1"
276276
path = "src/periph/rtc"
277277
optional = true
278278

279279
[dependencies.drone-stm32-map-periph-spi]
280-
version = "=0.10.0"
280+
version = "=0.10.1"
281281
path = "src/periph/spi"
282282
optional = true
283283

284284
[dependencies.drone-stm32-map-periph-tim]
285-
version = "=0.10.0"
285+
version = "=0.10.1"
286286
path = "src/periph/tim"
287287
optional = true
288288

289289
[dependencies.drone-stm32-map-periph-uart]
290-
version = "=0.10.0"
290+
version = "=0.10.1"
291291
path = "src/periph/uart"
292292
optional = true
293-
294-
[package.metadata.docs.rs]
295-
default-target = "thumbv7em-none-eabihf"
296-
features = ["stm32l4s9"]

‎Justfile‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ readme:
5454

5555
# Bump crate versions
5656
version-bump version drone-core-version drone-cortex-m-version:
57-
sed -i 's/\(docs\.rs\/drone-stm32-map\/\)[0-9]\+\(\.[0-9]\+\)\+/\1{{version}}/' \
57+
sed -i "s/\(api\.drone-os\.com\/drone-stm32-map\/\)[0-9]\+\(\.[0-9]\+\)\+/\1$(echo {{version}} | sed 's/\(.*\)\.[0-9]\+/\1/')/" \
5858
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
@@ -116,3 +116,12 @@ publish:
116116
cd src/periph/uart && cargo publish --target {{build_target}} --features "{{features}}"
117117
sleep 5
118118
cargo publish --target {{build_target}} --features "{{features}}"
119+
120+
# Publish the docs to api.drone-os.com
121+
publish-doc: doc
122+
dir=$(sed -n 's/.*api\.drone-os\.com\/\(.*\)"/\1/;T;p' Cargo.toml) \
123+
&& rm -rf ../drone-api/$dir \
124+
&& cp -rT target/doc ../drone-api/$dir \
125+
&& cp -rT target/{{build_target}}/doc ../drone-api/$dir \
126+
&& echo '<!DOCTYPE html><meta http-equiv="refresh" content="0; URL=./drone_stm32_map">' > ../drone-api/$dir/index.html \
127+
&& cd ../drone-api && git add $dir && git commit -m "Docs for $dir"

‎README.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
[![crates.io](https://img.shields.io/crates/v/drone-stm32-map.svg)](https://crates.io/crates/drone-stm32-map)
2-
[![docs.rs](https://docs.rs/drone-stm32-map/badge.svg)](https://docs.rs/drone-stm32-map)
32
![maintenance](https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg)
43

54
# drone-stm32-map
@@ -44,7 +43,7 @@ model.
4443
## Documentation
4544

4645
- [Drone Book](https://book.drone-os.com/)
47-
- [API documentation](https://docs.rs/drone-stm32-map/0.10.0)
46+
- [API documentation](https://api.drone-os.com/drone-stm32-map/0.10)
4847

4948
The API documentation intentionally skips auto-generated [`reg`] and [`thr`]
5049
bindings. Otherwise it would use several gigabytes of space and would be
@@ -58,7 +57,7 @@ Place the following to the Cargo.toml:
5857

5958
```toml
6059
[dependencies]
61-
drone-stm32-map = { version = "0.10.0", features = [...] }
60+
drone-stm32-map = { version = "0.10.1", features = [...] }
6261
```
6362

6463
## License

‎README.tpl‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
[![crates.io](https://img.shields.io/crates/v/{{crate}}.svg)](https://crates.io/crates/{{crate}})
2-
[![docs.rs](https://docs.rs/{{crate}}/badge.svg)](https://docs.rs/{{crate}})
32
![maintenance](https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg)
43

54
# {{crate}}

‎src/lib.rs‎

Lines changed: 2 additions & 2 deletions
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://docs.rs/drone-stm32-map/0.10.0)
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
@@ -52,7 +52,7 @@
5252
//!
5353
//! ```toml
5454
//! [dependencies]
55-
//! drone-stm32-map = { version = "0.10.0", features = [...] }
55+
//! drone-stm32-map = { version = "0.10.1", features = [...] }
5656
//! ```
5757
5858
#![deny(elided_lifetimes_in_paths)]

‎src/periph/adc/Cargo.toml‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "drone-stm32-map-periph-adc"
3-
version = "0.10.0"
3+
version = "0.10.1"
44
authors = ["Valentine Valyaeff <[email protected]>"]
55
edition = "2018"
66
repository = "https://github.com/drone-os/drone-stm32-map"
@@ -41,9 +41,5 @@ version = "0.10.0"
4141
path = "../../../../drone-cortex-m"
4242

4343
[dependencies.drone-stm32-map-pieces]
44-
version = "=0.10.0"
44+
version = "=0.10.1"
4545
path = "../../pieces"
46-
47-
[package.metadata.docs.rs]
48-
default-target = "thumbv7em-none-eabihf"
49-
features = ["stm32l4s9"]

‎src/periph/dma/Cargo.toml‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "drone-stm32-map-periph-dma"
3-
version = "0.10.0"
3+
version = "0.10.1"
44
authors = ["Valentine Valyaeff <[email protected]>"]
55
edition = "2018"
66
repository = "https://github.com/drone-os/drone-stm32-map"
@@ -41,9 +41,5 @@ version = "0.10.0"
4141
path = "../../../../drone-cortex-m"
4242

4343
[dependencies.drone-stm32-map-pieces]
44-
version = "=0.10.0"
44+
version = "=0.10.1"
4545
path = "../../pieces"
46-
47-
[package.metadata.docs.rs]
48-
default-target = "thumbv7em-none-eabihf"
49-
features = ["stm32l4s9"]

‎src/periph/exti/Cargo.toml‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "drone-stm32-map-periph-exti"
3-
version = "0.10.0"
3+
version = "0.10.1"
44
authors = ["Valentine Valyaeff <[email protected]>"]
55
edition = "2018"
66
repository = "https://github.com/drone-os/drone-stm32-map"
@@ -41,9 +41,5 @@ version = "0.10.0"
4141
path = "../../../../drone-cortex-m"
4242

4343
[dependencies.drone-stm32-map-pieces]
44-
version = "=0.10.0"
44+
version = "=0.10.1"
4545
path = "../../pieces"
46-
47-
[package.metadata.docs.rs]
48-
default-target = "thumbv7em-none-eabihf"
49-
features = ["stm32l4s9"]

‎src/periph/gpio/Cargo.toml‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "drone-stm32-map-periph-gpio"
3-
version = "0.10.0"
3+
version = "0.10.1"
44
authors = ["Valentine Valyaeff <[email protected]>"]
55
edition = "2018"
66
repository = "https://github.com/drone-os/drone-stm32-map"
@@ -41,9 +41,5 @@ version = "0.10.0"
4141
path = "../../../../drone-cortex-m"
4242

4343
[dependencies.drone-stm32-map-pieces]
44-
version = "=0.10.0"
44+
version = "=0.10.1"
4545
path = "../../pieces"
46-
47-
[package.metadata.docs.rs]
48-
default-target = "thumbv7em-none-eabihf"
49-
features = ["stm32l4s9"]

0 commit comments

Comments
 (0)