summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJustus Winter <justus@sequoia-pgp.org>2021-01-20 08:10:41 +0100
committerJustus Winter <justus@sequoia-pgp.org>2021-01-20 08:23:44 +0100
commit85fdd6032f45f12f5c5fc68354f085e4d1301f78 (patch)
treec88d4631fc8347c71871dddbdcef4433bf21d4f4
parent5c4faf806ba7b27cd0ff3db9b3fe435434b9ae18 (diff)
Add branding to all crates.
-rw-r--r--autocrypt/src/lib.rs3
-rw-r--r--buffered-reader/src/lib.rs2
-rw-r--r--core/src/lib.rs2
-rw-r--r--ffi-macros/src/lib.rs2
-rw-r--r--ffi/src/lib.rs2
-rw-r--r--guide/src/lib.rs3
-rw-r--r--ipc/src/lib.rs3
-rw-r--r--net/src/lib.rs2
-rw-r--r--openpgp-ffi/src/lib.rs2
-rw-r--r--sq/build.rs4
-rw-r--r--sq/src/sq-usage.rs3
-rw-r--r--sqv/build.rs5
-rw-r--r--sqv/src/sqv-usage.rs3
-rw-r--r--store/src/lib.rs2
14 files changed, 38 insertions, 0 deletions
diff --git a/autocrypt/src/lib.rs b/autocrypt/src/lib.rs
index fe56fd08..fe9abe31 100644
--- a/autocrypt/src/lib.rs
+++ b/autocrypt/src/lib.rs
@@ -11,6 +11,9 @@
//! of Autocrypt headers and setup messages. Note: Autocrypt is more
//! than just headers; it requires tight integration with the MUA.
+#![doc(html_favicon_url = "https://docs.sequoia-pgp.org/favicon.png")]
+#![doc(html_logo_url = "https://docs.sequoia-pgp.org/logo.svg")]
+
use base64;
use std::convert::TryFrom;
diff --git a/buffered-reader/src/lib.rs b/buffered-reader/src/lib.rs
index 4e049a8e..29a2afc2 100644
--- a/buffered-reader/src/lib.rs
+++ b/buffered-reader/src/lib.rs
@@ -223,6 +223,8 @@
//! [`BufReader`]: https://doc.rust-lang.org/stable/std/io/struct.BufReader.html
//! [HTTP's chunk transfer encoding]: https://en.wikipedia.org/wiki/Chunked_transfer_encoding
+#![doc(html_favicon_url = "https://docs.sequoia-pgp.org/favicon.png")]
+#![doc(html_logo_url = "https://docs.sequoia-pgp.org/logo.svg")]
#![warn(missing_docs)]
use std::io;
diff --git a/core/src/lib.rs b/core/src/lib.rs
index cc691640..566784c9 100644
--- a/core/src/lib.rs
+++ b/core/src/lib.rs
@@ -18,6 +18,8 @@
//! # }
//! ```
+#![doc(html_favicon_url = "https://docs.sequoia-pgp.org/favicon.png")]
+#![doc(html_logo_url = "https://docs.sequoia-pgp.org/logo.svg")]
use dirs;
use tempfile;
diff --git a/ffi-macros/src/lib.rs b/ffi-macros/src/lib.rs
index 1500a721..8a3ff3aa 100644
--- a/ffi-macros/src/lib.rs
+++ b/ffi-macros/src/lib.rs
@@ -1,5 +1,7 @@
//! Common macros for Sequoia's FFI crates.
+#![doc(html_favicon_url = "https://docs.sequoia-pgp.org/favicon.png")]
+#![doc(html_logo_url = "https://docs.sequoia-pgp.org/logo.svg")]
#![recursion_limit="512"]
use std::collections::HashMap;
diff --git a/ffi/src/lib.rs b/ffi/src/lib.rs
index 745ca6c8..66d65033 100644
--- a/ffi/src/lib.rs
+++ b/ffi/src/lib.rs
@@ -105,6 +105,8 @@
//! pgp_cert_free (cert);
//! ```
+#![doc(html_favicon_url = "https://docs.sequoia-pgp.org/favicon.png")]
+#![doc(html_logo_url = "https://docs.sequoia-pgp.org/logo.svg")]
#![warn(missing_docs)]
use sequoia_ffi_macros;
diff --git a/guide/src/lib.rs b/guide/src/lib.rs
index 7fe94663..08fdb9ca 100644
--- a/guide/src/lib.rs
+++ b/guide/src/lib.rs
@@ -19,4 +19,7 @@ Happy climbing!
"]
+#![doc(html_favicon_url = "https://docs.sequoia-pgp.org/favicon.png")]
+#![doc(html_logo_url = "https://docs.sequoia-pgp.org/logo.svg")]
+
include!(concat!(env!("OUT_DIR"), "/src/lib.rs"));
diff --git a/ipc/src/lib.rs b/ipc/src/lib.rs
index 708a03f2..b1c357a8 100644
--- a/ipc/src/lib.rs
+++ b/ipc/src/lib.rs
@@ -36,6 +36,9 @@
//! Windows support is currently not implemented, but should be
//! straight forward.
+#![doc(html_favicon_url = "https://docs.sequoia-pgp.org/favicon.png")]
+#![doc(html_logo_url = "https://docs.sequoia-pgp.org/logo.svg")]
+
use std::fs;
use std::io::{self, Read, Write};
use std::net::{Ipv4Addr, SocketAddr, TcpStream, TcpListener};
diff --git a/net/src/lib.rs b/net/src/lib.rs
index 450375cf..6055f5ad 100644
--- a/net/src/lib.rs
+++ b/net/src/lib.rs
@@ -24,6 +24,8 @@
//! # }
//! ```
+#![doc(html_favicon_url = "https://docs.sequoia-pgp.org/favicon.png")]
+#![doc(html_logo_url = "https://docs.sequoia-pgp.org/logo.svg")]
#![warn(missing_docs)]
use hyper::client::{ResponseFuture, HttpConnector};
diff --git a/openpgp-ffi/src/lib.rs b/openpgp-ffi/src/lib.rs
index d36582a3..e7957745 100644
--- a/openpgp-ffi/src/lib.rs
+++ b/openpgp-ffi/src/lib.rs
@@ -313,6 +313,8 @@
//! pgp_reader_free (armor);
//! ```
+#![doc(html_favicon_url = "https://docs.sequoia-pgp.org/favicon.png")]
+#![doc(html_logo_url = "https://docs.sequoia-pgp.org/logo.svg")]
#![warn(missing_docs)]
use libc;
diff --git a/sq/build.rs b/sq/build.rs
index 25a9af8d..2a09a1e0 100644
--- a/sq/build.rs
+++ b/sq/build.rs
@@ -19,6 +19,10 @@ fn main() {
&mut sq,
vec![],
"#").unwrap();
+ writeln!(main, "\n#![doc(html_favicon_url = \"https://docs.sequoia-pgp.org/favicon.png\")]")
+ .unwrap();
+ writeln!(main, "#![doc(html_logo_url = \"https://docs.sequoia-pgp.org/logo.svg\")]")
+ .unwrap();
writeln!(main, "\ninclude!(\"sq.rs\");").unwrap();
let outdir = match env::var_os("CARGO_TARGET_DIR") {
diff --git a/sq/src/sq-usage.rs b/sq/src/sq-usage.rs
index 761b7aab..1a70741d 100644
--- a/sq/src/sq-usage.rs
+++ b/sq/src/sq-usage.rs
@@ -733,4 +733,7 @@
//! <EMAIL_ADDRESS> The email address from which to obtain the WKD URI.
//! ```
+#![doc(html_favicon_url = "https://docs.sequoia-pgp.org/favicon.png")]
+#![doc(html_logo_url = "https://docs.sequoia-pgp.org/logo.svg")]
+
include!("sq.rs");
diff --git a/sqv/build.rs b/sqv/build.rs
index b53caa33..f96d7c8b 100644
--- a/sqv/build.rs
+++ b/sqv/build.rs
@@ -19,6 +19,11 @@ fn main() {
&mut sqv,
vec![],
"#").unwrap();
+
+ writeln!(main, "\n#![doc(html_favicon_url = \"https://docs.sequoia-pgp.org/favicon.png\")]")
+ .unwrap();
+ writeln!(main, "#![doc(html_logo_url = \"https://docs.sequoia-pgp.org/logo.svg\")]")
+ .unwrap();
writeln!(main, "\ninclude!(\"sqv.rs\");").unwrap();
let outdir = match env::var_os("CARGO_TARGET_DIR") {
diff --git a/sqv/src/sqv-usage.rs b/sqv/src/sqv-usage.rs
index b1fd16d9..589d9a96 100644
--- a/sqv/src/sqv-usage.rs
+++ b/sqv/src/sqv-usage.rs
@@ -31,4 +31,7 @@
//! '2017-03-04', '2017031', ...). If no timezone is specified, UTC is assumed.
//! ```
+#![doc(html_favicon_url = "https://docs.sequoia-pgp.org/favicon.png")]
+#![doc(html_logo_url = "https://docs.sequoia-pgp.org/logo.svg")]
+
include!("sqv.rs");
diff --git a/store/src/lib.rs b/store/src/lib.rs
index 93b6402c..7a80e182 100644
--- a/store/src/lib.rs
+++ b/store/src/lib.rs
@@ -47,6 +47,8 @@
//! # }
//! ```
+#![doc(html_favicon_url = "https://docs.sequoia-pgp.org/favicon.png")]
+#![doc(html_logo_url = "https://docs.sequoia-pgp.org/logo.svg")]
#![warn(missing_docs)]
use capnp;