Use docs.rs for documentation (#40)

* Use docs.rs for documentation

This would also allow deleting the `gh-pages` branch (which is pretty large).
I'd also recommend adding `badges` and `categories` to make the crates.io page more useful (see [this](http://www.integer32.com/2017/01/20/categories-and-ci-badges.html)), but I'll leave that up to you.

* Remove more references to old docs
This commit is contained in:
Jon Gjengset 2017-09-28 17:19:54 -04:00 committed by Matt McCoy
parent 6a2aed4054
commit 300cfc04f8
3 changed files with 3 additions and 5 deletions

View file

@ -19,8 +19,6 @@ script:
- | - |
travis-cargo build && travis-cargo build &&
travis-cargo test && travis-cargo test &&
travis-cargo bench && travis-cargo bench
travis-cargo --only stable doc
after_success: after_success:
- travis-cargo --only stable doc-upload
- travis-cargo coveralls --exclude-pattern=/target --no-sudo - travis-cargo coveralls --exclude-pattern=/target --no-sudo

View file

@ -3,7 +3,7 @@
name = "imap" name = "imap"
version = "0.4.0" version = "0.4.0"
authors = ["Matt McCoy <mattnenterprise@yahoo.com>"] authors = ["Matt McCoy <mattnenterprise@yahoo.com>"]
documentation = "http://mattnenterprise.github.io/rust-imap" documentation = "https://docs.rs/imap/"
repository = "https://github.com/mattnenterprise/rust-imap" repository = "https://github.com/mattnenterprise/rust-imap"
homepage = "https://github.com/mattnenterprise/rust-imap" homepage = "https://github.com/mattnenterprise/rust-imap"
description = "IMAP client for Rust" description = "IMAP client for Rust"

View file

@ -8,7 +8,7 @@ IMAP Client for Rust
[![Coverage Status](https://coveralls.io/repos/github/mattnenterprise/rust-imap/badge.svg?branch=master)](https://coveralls.io/github/mattnenterprise/rust-imap?branch=master) [![Coverage Status](https://coveralls.io/repos/github/mattnenterprise/rust-imap/badge.svg?branch=master)](https://coveralls.io/github/mattnenterprise/rust-imap?branch=master)
[Documentation](http://mattnenterprise.github.io/rust-imap) [Documentation](https://docs.rs/imap/)
### Usage ### Usage
Here is a basic example of using the client. See the examples directory for more examples. Here is a basic example of using the client. See the examples directory for more examples.