diff --git a/.travis.yml b/.travis.yml index 633b1e10..9070d7b9 100644 --- a/.travis.yml +++ b/.travis.yml @@ -29,7 +29,7 @@ script: - (cd examples/serde-syntex-example && travis-cargo --only nightly run -- --no-default-features --features unstable) - (cd serde && travis-cargo --only stable doc) after_success: -- (cd serde && travis-cargo --only stable doc-upload --branch docs) +- (cd serde && mkdir -p target/doc && echo docs.serde.rs > target/doc/CNAME && travis-cargo --only stable doc-upload --branch docs) - (cd testing && travis-cargo --only stable coveralls --no-sudo) env: global: diff --git a/README.md b/README.md index ae0c1ae6..cc19eb2d 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ information. In many situations, the handshake protocol between serializers and serializees can be completely optimized away, leaving Serde to perform roughly the same speed as a hand written serializer for a specific type. -[Documentation](https://serde-rs.github.io/serde/serde/index.html) +[Documentation](http://docs.serde.rs/serde/) Simple Serde Example ==================== @@ -331,9 +331,9 @@ Serialization without Macros Under the covers, Serde extensively uses the Visitor pattern to thread state between the -[Serializer](http://serde-rs.github.io/serde/serde/serde/ser/trait.Serializer.html) +[Serializer](http://docs.serde.rs/serde/ser/trait.Serializer.html) and -[Serialize](http://serde-rs.github.io/serde/serde/serde/ser/trait.Serialize.html) +[Serialize](http://docs.serde.rs/serde/ser/trait.Serialize.html) without the two having specific information about each other's concrete type. This has many of the same benefits as frameworks that use runtime type information without the overhead. In fact, when compiling with optimizations, @@ -342,7 +342,7 @@ nearly as fast as a hand written serializer format for a specific type. To see it in action, lets look at how a simple type like `i32` is serialized. The -[Serializer](http://serde-rs.github.io/serde/serde/serde/ser/trait.Serializer.html) +[Serializer](http://docs.serde.rs/serde/ser/trait.Serializer.html) is threaded through the type: ```rust,ignore @@ -413,11 +413,11 @@ Deserialization without Macros Deserialization is a little more complicated since there's a bit more error handling that needs to occur. Let's start with the simple `i32` -[Deserialize](http://serde-rs.github.io/serde/serde/serde/de/trait.Deserialize.html) +[Deserialize](http://docs.serde.rs/serde/de/trait.Deserialize.html) implementation. It passes a -[Visitor](http://serde-rs.github.io/serde/serde/serde/de/trait.Visitor.html) to the -[Deserializer](http://serde-rs.github.io/serde/serde/serde/de/trait.Deserializer.html). -The [Visitor](http://serde-rs.github.io/serde/serde/serde/de/trait.Visitor.html) +[Visitor](http://docs.serde.rs/serde/de/trait.Visitor.html) to the +[Deserializer](http://docs.serde.rs/serde/de/trait.Deserializer.html). +The [Visitor](http://docs.serde.rs/serde/de/trait.Visitor.html) can create the `i32` from a variety of different types: ```rust,ignore @@ -452,9 +452,9 @@ impl serde::de::Visitor for I32Visitor { Since it's possible for this type to get passed an unexpected type, we need a way to error out. This is done by way of the -[Error](http://serde-rs.github.io/serde/serde/serde/de/trait.Error.html) trait, +[Error](http://docs.serde.rs/serde/de/trait.Error.html) trait, which allows a -[Deserialize](http://serde-rs.github.io/serde/serde/serde/de/trait.Deserialize.html) +[Deserialize](http://docs.serde.rs/serde/de/trait.Deserialize.html) to generate an error for a few common error conditions. Here's how it could be used: ```rust,ignore @@ -471,9 +471,9 @@ to generate an error for a few common error conditions. Here's how it could be u ``` Maps follow a similar pattern as before, and use a -[MapVisitor](http://serde-rs.github.io/serde/serde/serde/de/trait.MapVisitor.html) +[MapVisitor](http://docs.serde.rs/serde/de/trait.MapVisitor.html) to walk through the values generated by the -[Deserializer](http://serde-rs.github.io/serde/serde/serde/de/trait.Deserializer.html). +[Deserializer](http://docs.serde.rs/serde/de/trait.Deserializer.html). ```rust,ignore impl serde::Deserialize for BTreeMap diff --git a/serde/Cargo.toml b/serde/Cargo.toml index 0ccd6ac4..dba248ec 100644 --- a/serde/Cargo.toml +++ b/serde/Cargo.toml @@ -5,7 +5,7 @@ authors = ["Erick Tryzelaar "] license = "MIT/Apache-2.0" description = "A generic serialization/deserialization framework" repository = "https://github.com/serde-rs/serde" -documentation = "https://serde-rs.github.io/serde/serde/" +documentation = "http://docs.serde.rs/serde/" readme = "../README.md" keywords = ["serde", "serialization"] include = ["Cargo.toml", "src/**/*.rs"] diff --git a/serde/src/lib.rs b/serde/src/lib.rs index 7a45b06f..035e25a9 100644 --- a/serde/src/lib.rs +++ b/serde/src/lib.rs @@ -9,7 +9,7 @@ //! For a detailed tutorial on the different ways to use serde please check out the //! [github repository](https://github.com/serde-rs/serde) -#![doc(html_root_url="https://serde-rs.github.io/serde")] +#![doc(html_root_url="http://docs.serde.rs")] #![cfg_attr(not(feature = "std"), no_std)] #![cfg_attr(feature = "unstable", feature(reflect_marker, unicode, nonzero, plugin, step_trait, zero_one))] #![cfg_attr(feature = "alloc", feature(alloc))] diff --git a/serde_test/Cargo.toml b/serde_test/Cargo.toml index efd0fe6c..e29783e1 100644 --- a/serde_test/Cargo.toml +++ b/serde_test/Cargo.toml @@ -5,7 +5,7 @@ authors = ["Erick Tryzelaar "] license = "MIT/Apache-2.0" description = "Token De/Serializer for testing De/Serialize implementations" repository = "https://github.com/serde-rs/serde" -documentation = "https://serde-rs.github.io/serde/serde/" +documentation = "http://docs.serde.rs/serde/" readme = "../README.md" keywords = ["serde", "serialization"] include = ["Cargo.toml", "src/**/*.rs"] diff --git a/testing/Cargo.toml b/testing/Cargo.toml index 3793d3c6..fc68f4fb 100644 --- a/testing/Cargo.toml +++ b/testing/Cargo.toml @@ -5,7 +5,7 @@ authors = ["Erick Tryzelaar "] license = "MIT/Apache-2.0" description = "A generic serialization/deserialization framework" repository = "https://github.com/serde-rs/serde" -documentation = "http://serde-rs.github.io/serde/serde" +documentation = "http://docs.serde.rs/serde/" readme = "README.md" keywords = ["serialization"] build = "build.rs"