aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/guide
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2016-08-30 14:18:14 +0200
committerLoïc Hoguin <[email protected]>2016-08-30 14:18:14 +0200
commit8fc1371df8e11074496b8cdc27363ad7e4f88934 (patch)
tree378dc77fc9674ad311f20d558a8fc00d98b4b1e7 /doc/src/guide
parent4c6f2c9a95a1292b6b1aef20ab902fce729ff4f0 (diff)
downloadcowboy-8fc1371df8e11074496b8cdc27363ad7e4f88934.tar.gz
cowboy-8fc1371df8e11074496b8cdc27363ad7e4f88934.tar.bz2
cowboy-8fc1371df8e11074496b8cdc27363ad7e4f88934.zip
Minor documentation fixes
"make docs" should now work again.
Diffstat (limited to 'doc/src/guide')
-rw-r--r--doc/src/guide/book.asciidoc1
-rw-r--r--doc/src/guide/cowboy.sty8
-rw-r--r--doc/src/guide/flow_diagram.asciidoc1
-rw-r--r--doc/src/guide/req.asciidoc8
4 files changed, 12 insertions, 6 deletions
diff --git a/doc/src/guide/book.asciidoc b/doc/src/guide/book.asciidoc
index b1c54d8..9c5f49e 100644
--- a/doc/src/guide/book.asciidoc
+++ b/doc/src/guide/book.asciidoc
@@ -1,4 +1,5 @@
// a2x: --dblatex-opts "-P latex.output.revhistory=0 -P doc.publisher.show=0 -P index.numbered=0"
+// a2x: --dblatex-opts "-s cowboy"
// a2x: -d book --attribute tabsize=4
= Cowboy User Guide
diff --git a/doc/src/guide/cowboy.sty b/doc/src/guide/cowboy.sty
new file mode 100644
index 0000000..d5e0d3b
--- /dev/null
+++ b/doc/src/guide/cowboy.sty
@@ -0,0 +1,8 @@
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesPackage{asciidoc-dblatex}[2012/10/24 AsciiDoc DocBook Style]
+
+%% Just use the original package and pass the options.
+\RequirePackageWithOptions{docbook}
+
+%% Define an alias for make snippets to be compatible with source-highlighter.
+\lstalias{makefile}{make}
diff --git a/doc/src/guide/flow_diagram.asciidoc b/doc/src/guide/flow_diagram.asciidoc
index 93e9051..1095404 100644
--- a/doc/src/guide/flow_diagram.asciidoc
+++ b/doc/src/guide/flow_diagram.asciidoc
@@ -1,3 +1,4 @@
+[[flow_diagram]]
== Flow diagram
Placeholder chapter.
diff --git a/doc/src/guide/req.asciidoc b/doc/src/guide/req.asciidoc
index 39cd1b6..5bd6701 100644
--- a/doc/src/guide/req.asciidoc
+++ b/doc/src/guide/req.asciidoc
@@ -1,7 +1,3 @@
-+++
-title = "The Req object"
-+++
-
[[req]]
== The Req object
@@ -160,8 +156,8 @@ The scheme and host are lowercased case insensitive binary
strings. The port is an integer representing the port number.
The path and query string are case sensitive binary strings.
-Cowboy defines only the <<"http">> and <<"https">> schemes.
-They are chosen so that the scheme will only be <<"https">>
+Cowboy defines only the `<<"http">>` and `<<"https">>` schemes.
+They are chosen so that the scheme will only be `<<"https">>`
for requests on secure HTTP/1.1 or HTTP/2 connections.
// @todo Is that tested well?