Просмотр исходного кода

Minor documentation fixes

"make docs" should now work again.
Loïc Hoguin 8 лет назад
Родитель
Сommit
8fc1371df8

+ 3 - 3
README.md

@@ -16,7 +16,7 @@ to handlers written in Erlang.
 Because it uses Ranch for managing connections, Cowboy can easily be
 **embedded** in any other application.
 
-No parameterized module. No process dictionary. **Clean** Erlang code.
+Cowboy is **clean** and **well tested** Erlang code.
 
 Sponsors
 --------
@@ -31,8 +31,8 @@ It has since been superseded by HTTP/2.
 Online documentation
 --------------------
 
- *  [User guide](http://ninenines.eu/docs/en/cowboy/HEAD/guide)
- *  [Function reference](http://ninenines.eu/docs/en/cowboy/HEAD/manual)
+ *  [User guide](http://ninenines.eu/docs/en/cowboy/2.0/guide)
+ *  [Function reference](http://ninenines.eu/docs/en/cowboy/2.0/manual)
 
 Offline documentation
 ---------------------

+ 1 - 0
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

+ 8 - 0
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}

+ 1 - 0
doc/src/guide/flow_diagram.asciidoc

@@ -1,3 +1,4 @@
+[[flow_diagram]]
 == Flow diagram
 
 Placeholder chapter.

+ 2 - 6
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?