Merge #152

152: doc related changes r=adamgreig a=japaric

see individual commit messages for details

Co-authored-by: Jorge Aparicio <[email protected]>

Author: bors[bot]

cortex-m-rt/Cargo.toml

@@ -2,7 +2,7 @@
 authors = ["Jorge Aparicio <[email protected]>", "Hideki Sekine <[email protected]>"]
 categories = ["embedded", "no-std"]
 description = "Minimal runtime / startup for Cortex-M microcontrollers"
-documentation = "https://rust-embedded.github.io/cortex-m-rt/"
+documentation = "https://docs.rs/cortex-m-rt/"
 keywords = ["arm", "cortex-m", "runtime", "startup"]
 license = "MIT OR Apache-2.0"
 name = "cortex-m-rt"
@@ -33,3 +33,6 @@ required-features = ["device"]
 
 [features]
 device = []
+
+[package.metadata.docs.rs]
+features = ["device"]

cortex-m-rt/src/lib.rs

@@ -16,19 +16,17 @@
 //!
 //! This crate also provides the following attributes:
 //!
-//! - [`#[entry]`] to declare the entry point of the program
-//! - [`#[exception]`] to override an exception handler. If not overridden all exception handlers
+//! - `#[entry]` to declare the entry point of the program
+//! - `#[exception]` to override an exception handler. If not overridden all exception handlers
 //!   default to an infinite loop.
-//! - [`#[pre_init]`] to run code *before* `static` variables are initialized
-//!
-//! [`#[entry]`]: ../cortex_m_rt_macros/fn.entry.html
-//! [`#[exception]`]: ../cortex_m_rt_macros/fn.exception.html
-//! [`#[pre_init]`]: ../cortex_m_rt_macros/fn.pre_init.html
+//! - `#[pre_init]` to run code *before* `static` variables are initialized
 //!
 //! This crate also implements a related attribute called `#[interrupt]`, which allows you
 //! to define interrupt handlers. However, since which interrupts are available depends on the
 //! microcontroller in use, this attribute should be re-exported and used from a device crate.
 //!
+//! The documentation for these attributes can be found in the [Reexports](#reexports) section.
+//!
 //! # Requirements
 //!
 //! ## `memory.x`