From 29b65f6bdd716be12eca20d5c791cd33fd44473f Mon Sep 17 00:00:00 2001 From: Sean McArthur Date: Thu, 14 Jul 2016 19:25:49 -0700 Subject: [PATCH] docs(guide): build and test markdown files in doc directory --- .travis.yml | 3 +-- .travis/docs.sh | 10 ++++++++++ doc/guide/server.md | 30 ++++++++++++++++++++++++++++++ 3 files changed, 41 insertions(+), 2 deletions(-) create mode 100644 doc/guide/server.md diff --git a/.travis.yml b/.travis.yml index 9a1edba8..75244fb1 100644 --- a/.travis.yml +++ b/.travis.yml @@ -22,7 +22,7 @@ script: - ./.travis/readme.py - cargo build --verbose $FEATURES - cargo test --verbose $FEATURES - - 'if [ $TRAVIS_RUST_VERSION = nightly ]; then cargo bench --no-run; fi' + - 'for f in ./doc/**/*.md; do rustdoc --test $f; done' addons: apt: @@ -40,7 +40,6 @@ after_success: | ./kcov-master/tmp/usr/local/bin/kcov --coveralls-id=$TRAVIS_JOB_ID --exclude-pattern=/.cargo target/kcov target/debug/hyper-* && [ $TRAVIS_PULL_REQUEST = false ] && { [ "$TRAVIS_TAG" != "" ] || [ "$TRAVIS_BRANCH" == "master" ]; } && - cargo doc --no-deps && ./.travis/docs.sh && echo "\nDocs published.\n" diff --git a/.travis/docs.sh b/.travis/docs.sh index 62b0fa84..9c042154 100755 --- a/.travis/docs.sh +++ b/.travis/docs.sh @@ -2,6 +2,16 @@ set -o errexit +shopt -s globstar + +cargo doc --no-deps + +for f in ./doc/**/*.md; do + rustdoc $f -L ./target/debug -L ./target/debug/deps -o "$(dirname $f)"; +done + +cp --parent ./doc/**/*.md ./target + git clone --branch gh-pages "https://$TOKEN@github.com/${TRAVIS_REPO_SLUG}.git" deploy_docs cd deploy_docs diff --git a/doc/guide/server.md b/doc/guide/server.md new file mode 100644 index 00000000..5f92d298 --- /dev/null +++ b/doc/guide/server.md @@ -0,0 +1,30 @@ +% Server Guide + +## The `Handler` + +```ignore,no_run +extern crate hyper; +use hyper::server::{Handler, Request, Response, Decoder, Encoder, Next, HttpStream as Http}; + +struct Hello; + +impl Handler for Hello { + fn on_request(&mut self, req: Request) -> Next { + + } + + fn on_request_readable(&mut self, decoder: &mut Decoder) -> Next { + + } + + fn on_response(&mut self, res: &mut Response) -> Next { + + } + + fn on_response_writable(&mut self, encoder: &mut Encoder) -> Next { + + } +} + +# fn main() {} +```