umgeher/cowboy
0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-15 12:40:25 +00:00
Code Issues Wiki Activity

Minor documentation fixes

Browse source 
"make docs" should now work again.
This commit is contained in:
Loïc Hoguin 2016-08-30 14:18:14 +02:00
parent 4c6f2c9a95
commit 8fc1371df8
5 changed files with 15 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

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

1
doc/src/guide/book.asciidoc
View file

@ -1,4 +1,5 @@
// a2x: --dblatex-opts "-P latex.output.revhistory=0 -P doc.publisher.show=0 -P index.numbered=0" // 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 // a2x: -d book --attribute tabsize=4
= Cowboy User Guide = Cowboy User Guide

8
doc/src/guide/cowboy.sty Normal file
View file

@ -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
doc/src/guide/flow_diagram.asciidoc
View file

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

8
doc/src/guide/req.asciidoc
View file

@ -1,7 +1,3 @@
+++
title = "The Req object"
+++
[[req]] [[req]]
== The Req object == 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. strings. The port is an integer representing the port number.
The path and query string are case sensitive binary strings. The path and query string are case sensitive binary strings.
Cowboy defines only the <<"http">> and <<"https">> schemes. Cowboy defines only the `<<"http">>` and `<<"https">>` schemes.
They are chosen so that the scheme will only be <<"https">> They are chosen so that the scheme will only be `<<"https">>`
for requests on secure HTTP/1.1 or HTTP/2 connections. for requests on secure HTTP/1.1 or HTTP/2 connections.
// @todo Is that tested well? // @todo Is that tested well?