forked/hyper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(guide): add styling to guides

Browse Source
This commit is contained in:
Sean McArthur
2016-07-15 16:34:19 -07:00
parent 2433780419
commit 181e806a18
5 changed files with 77 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.travis/docs.sh
View File

@@ -7,10 +7,11 @@ 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)";
rustdoc $f -L ./target/debug -L ./target/debug/deps -o "$(dirname $f)" --html-before-content=./doc/prelude.html.inc --html-after-content=./doc/postlude.html.inc --markdown-css=guide.css;
done
cp --parent ./doc/**/*.html ./target
cp ./doc/guide.css ./target/doc/guide/guide.css
git clone --branch gh-pages "https://$TOKEN@github.com/${TRAVIS_REPO_SLUG}.git" deploy_docs
cd deploy_docs

2
doc/guide.css Normal file
View File

@@ -0,0 +1,2 @@
@import url('../rustdoc.css')
@import url('../main.css')

1
doc/postlude.html.inc Normal file
View File

@@ -0,0 +1 @@
</section><!-- /main-->

9
doc/prelude.html.inc Normal file
View File

@@ -0,0 +1,9 @@
<nav class="sidebar">
<p class="location">
<a href="../../">hyper</a>
::
<wbr>
<a href="../">guide</a>
</p>
</nav>
<section id="main" class="content mod">

63
doc/server.html Normal file
View File

@@ -0,0 +1,63 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<title>Server Guide</title>
<link rel="stylesheet" type="text/css" href="guide.css">
</head>
<body class="rustdoc">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class="location"></p>
</nav>
<section id="main" class="content mod">
<h1 class="title">Server Guide</h1>
<nav id="TOC"><ul>
<li><a href="#the-handler">0.1 The <code>Handler</code></a><ul></ul></li></ul></nav>
<h2 id='the-handler' class='section-header'><a href='#the-handler'>0.1 The <code>Handler</code></a></h2>
<pre class='rust rust-example-rendered'>
<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>hyper</span>;
<span class='kw'>use</span> <span class='ident'>hyper</span>::<span class='ident'>server</span>::{<span class='ident'>Handler</span>, <span class='ident'>Request</span>, <span class='ident'>Response</span>, <span class='ident'>Decoder</span>, <span class='ident'>Encoder</span>, <span class='ident'>Next</span>, <span class='ident'>HttpStream</span> <span class='kw'>as</span> <span class='ident'>Http</span>};
<span class='kw'>struct</span> <span class='ident'>Hello</span>;
<span class='kw'>impl</span> <span class='ident'>Handler</span><span class='op'>&lt;</span><span class='ident'>Http</span><span class='op'>&gt;</span> <span class='kw'>for</span> <span class='ident'>Hello</span> {
<span class='kw'>fn</span> <span class='ident'>on_request</span>(<span class='kw-2'>&amp;</span><span class='kw-2'>mut</span> <span class='self'>self</span>, <span class='ident'>req</span>: <span class='ident'>Request</span><span class='op'>&lt;</span><span class='ident'>Http</span><span class='op'>&gt;</span>) <span class='op'>-&gt;</span> <span class='ident'>Next</span> {
}
<span class='kw'>fn</span> <span class='ident'>on_request_readable</span>(<span class='kw-2'>&amp;</span><span class='kw-2'>mut</span> <span class='self'>self</span>, <span class='ident'>decoder</span>: <span class='kw-2'>&amp;</span><span class='kw-2'>mut</span> <span class='ident'>Decoder</span><span class='op'>&lt;</span><span class='ident'>Http</span><span class='op'>&gt;</span>) <span class='op'>-&gt;</span> <span class='ident'>Next</span> {
}
<span class='kw'>fn</span> <span class='ident'>on_response</span>(<span class='kw-2'>&amp;</span><span class='kw-2'>mut</span> <span class='self'>self</span>, <span class='ident'>res</span>: <span class='kw-2'>&amp;</span><span class='kw-2'>mut</span> <span class='ident'>Response</span>) <span class='op'>-&gt;</span> <span class='ident'>Next</span> {
}
<span class='kw'>fn</span> <span class='ident'>on_response_writable</span>(<span class='kw-2'>&amp;</span><span class='kw-2'>mut</span> <span class='self'>self</span>, <span class='ident'>encoder</span>: <span class='kw-2'>&amp;</span><span class='kw-2'>mut</span> <span class='ident'>Encoder</span><span class='op'>&lt;</span><span class='ident'>Http</span><span class='op'>&gt;</span>) <span class='op'>-&gt;</span> <span class='ident'>Next</span> {
}
}
</pre>
<script type="text/javascript">
window.playgroundUrl = "";
</script>
</section><!-- /main-->
</body>
</html>