Commit graph

230 commits

Author SHA1 Message Date
Ivan Lazar Miljenovic
b3e35fbc79 Make sure tutorial can build 2017-10-09 13:22:54 +11:00
Ivan Lazar Miljenovic
dc40badb7c Add motivating example for markdownWith to tutorial 2017-10-06 13:38:37 +11:00
Ivan Lazar Miljenovic
02821e326a Update sample servant-docs output in tutorial
Not all of this is due to the changes in multiple content-type
handling.
2017-10-06 13:21:20 +11:00
Oleg Grenrus
15cc4f55dd Update docs related to hoistServer 2017-10-01 20:24:22 +03:00
Julian K. Arni
da8337809b Documentation fixes 2017-09-14 09:54:13 -04:00
Oleg Grenrus
c46dd1aff9 Bump servant-docs version to 0.11 2017-07-24 10:54:11 +03:00
JoeMShanahan
e6c492ab2c Add hackage link to the cookie package 2017-07-17 11:18:13 +01:00
JoeMShanahan
2c0aa36ae9 Reword comment so that it actually makes sense! 2017-07-17 10:51:08 +01:00
JoeMShanahan
160cda2602 Explicitly state that we're adding a dependency here 2017-07-17 10:14:42 +01:00
JoeMShanahan
c24096be16 Bring back the comment 2017-07-17 10:09:51 +01:00
Joe Shanahan
400bd564dc Look inside cookies instead of just the header 2017-07-17 09:18:34 +01:00
Chris Martin
fbf870ac8a typo: "philosophy" 2017-06-20 11:42:08 -04:00
Oleg Grenrus
ec930ac9a8 Release 0.11 2017-05-24 08:02:56 +03:00
shak-mar
76703e5b80 Fix typo in ApiType.lhs 2017-05-19 15:02:10 +02:00
David Turner
8b993b9d11 Changes to docs as suggested 2017-05-17 08:24:04 +00:00
David Turner
aa3716b6aa Tidy up tutorial 2017-05-17 05:50:38 +00:00
David Turner
0bbc4f98a4 Rename EmptyAPIClient to EmptyClient 2017-05-16 16:00:15 +00:00
David Turner
f5d9983381 Rename emptyAPIServer to emptyServer 2017-05-16 15:59:41 +00:00
David Turner
fa3f1869f2 Add EmptyForeignAPI and instance HasForeign ... EmptyAPI 2017-05-16 10:07:30 +00:00
David Turner
2cfa71891b Add instance HasDocs EmptyAPI 2017-05-16 10:07:15 +00:00
David Turner
a87067a6c1 Actually, serve this one so it's useful in the Docs tutorial 2017-05-16 10:07:12 +00:00
David Turner
4c64c13af0 Add EmptyAPIClient and instance HasClient EmptyAPI 2017-05-16 10:06:48 +00:00
David Turner
94483d586c Add instance HasServer EmptyAPI 2017-05-16 10:06:25 +00:00
David Turner
8a16f47fba Add EmptyAPI example (no prose yet) 2017-05-16 10:06:23 +00:00
David Turner
b81fbe445d Renumber again to make room for the EmptyAPI example 2017-05-16 10:06:16 +00:00
David Turner
e8c7158600 Renumber APIs in the tutorial to be in order 2017-05-16 10:06:00 +00:00
Alexander Vieth
6389134423 Change to ServerT Raw m = Tagged m Application
For uniformity of Enter.

Previously, `ServerT Raw m ~ Application`. Seems reasonable, but has the
unfortunate consequence of making `Enter` useless for `Raw` routes.
With this change `Tagged m Application` is retagged by `Enter`.
2017-05-15 19:54:43 +03:00
Nick B
fa422bb298 Docs: Updated wording as per PR comments. 2017-04-11 08:34:57 +01:00
Nick B
45a7bb1b73 Improve Client docs
* Use suggestion in #606 to document pattern matching client behaviour better
 * Helpful suggestion of reading in order in the index
 * A couple of extra internal links
 * Fox some typos / punctuation.

Fixes #606
2017-04-07 21:02:57 +01:00
Nick B
3115b57145 Use newer release of Pygments
* Includes [Haskell types fix by @teh](https://bitbucket.org/birkenfeld/pygments-main/pull-requests/685/two-haskell-fixes/diff)
 * Local docs build then exhibit proper Haskell highlighting including type literals etc

 Fixes #359
2017-03-11 14:53:48 +00:00
Oleg Grenrus
29f94a6440 Briefly correct ExceptT mentions into Handler (#693) 2017-01-30 15:45:13 +02:00
Christian Takle
cdda7bcf8d Make type consistent with whats written on line 20 (#688)
Make type consistent with whats written on line 20
2017-01-29 20:59:41 +02:00
Oleg Grenrus
93df8d22df Bump version to 0.10 2017-01-26 20:10:01 +02:00
Arash Rouhani
a425c3ae43 tutorial: Update type of BaseUrl to real type
I got confused to why there was one more argument passed to
constructor than the type takes. Turns out the docs were just a bit out
of date.
2017-01-25 09:53:54 +07:00
Arash Rouhani
e26f123555 tutorial: Make "Position" type consistent
I think this change was just overlooked in
https://github.com/haskell-servant/servant/pull/355

Without this change, running the server from Server.lhs and client from
Client.lhs will result in something like

    decodeError = "Error in $: The key \"x\" was not found
2017-01-25 09:53:54 +07:00
Alp Mestanogullari
c655c6e474 tutorial fix 2017-01-17 14:14:46 +02:00
Alp Mestanogullari
8efabed5c6 Revamp static file serving module.
Instead of only exposing 'serveDirectory', which picks a specific static file
serving strategy (file server settings), we now expose 4 different variants each
corresponding to an variant of StaticSettings in wai-app-static.

In addition to these, we expose a more flexible 'serveDirectoryWith' function
which allows the user to specify some arbitrary StaticSettings, if the 4
existing variants do not cover a user's needs.
2017-01-17 14:14:46 +02:00
Oleg Grenrus
d5e73bf577 Make servant buildable with cabal new-build 2017-01-16 11:03:06 +02:00
Oleg Grenrus
34166ae749 Update tutorial (NT changes) 2016-11-16 08:29:36 +02:00
Julian K. Arni
4fd31a60fb Bump version.
To 0.9.1.1
2016-10-27 13:25:27 +02:00
Julian K. Arni
9e809a0756 Bump version.
To 0.9.1.
2016-10-26 17:35:57 +02:00
Julian K. Arni
5e09493aa6 Add more documentation about response headers to tutorial. 2016-10-26 17:17:34 +02:00
Ruben Moor
f352f3b136 Update Authentication.lhs 2016-10-14 11:09:46 -04:00
Julian K. Arni
3ddf225cec Bump version.
To 0.9.0.1.
2016-10-09 22:52:49 +02:00
Sönke Hahn
bc1a3e7faa bump version 2016-09-17 11:47:57 -04:00
Christian Klinger
7a7f7d7cf5 changed ClientM to be a Reader of ClientEnv 2016-09-08 00:17:13 +02:00
Julian K. Arni
bf824a3889 Bump version to 0.8.1 2016-09-02 13:09:47 -03:00
Cornelius Diekmann
47eed38ee6 Fixed typo: s/real/realm/
Actually, I'm just trying to learn servant and I'm reading the doc for the first time. But this just looks like a typo to me.
2016-09-02 16:38:03 +02:00
Julian K. Arni
b22e4e72f9 Review fixes 2016-08-17 13:37:34 -03:00
Julian K. Arni
7aa550aa05 Make Javascript tutorial compile. 2016-08-17 13:37:34 -03:00
freezeboy
9e71fde756 Fixing typo in Javascript.lhs 2016-08-17 13:37:34 -03:00
Julian K. Arni
95d077f586 Add more JS documentation.
Contributed by freezeboy in PR #11 -
    https://github.com/haskell-servant/haskell-servant.github.io/pull/11/files
2016-08-17 13:37:34 -03:00
Sönke Hahn
4ccfce2331 docs: bump Sphinx version 2016-08-15 13:52:14 +02:00
Sönke Hahn
ecfa78d222 doc: add a tip about how to serve on / 2016-07-15 19:31:16 +02:00
Sönke Hahn
8eb412ff23 bump version 2016-07-10 17:21:36 +02:00
Arian van Putten
d782ef19f7 Fix a warning that the test suite gave 2016-07-10 16:59:54 +02:00
Sönke Hahn
0f1e5475b9 doc: add two more examples for servant projects 2016-07-03 11:53:20 +08:00
Christopher League
69d3e7355a Fix minor typo in tutorial 2016-05-24 23:11:54 -04:00
Julian Arni
ff40b327bc Merge pull request #504 from haskell-servant/jkarni/doc-fixes
Doc fixes
2016-05-12 09:53:35 +02:00
Julian K. Arni
aed6f7b910 Review fix 2016-05-11 10:17:24 +02:00
Sönke Hahn
d8a4cce691 version bump 2016-05-11 12:09:25 +08:00
Julian K. Arni
e0ba34372e Remove link to 0.4 version of tutorial.
Stackage has 0.5 already, and the 0.4 version has numerous mistakes.
2016-05-10 13:39:01 +02:00
Julian K. Arni
efbe6fd498 Use NoContent and fix content-type lists in docs. 2016-05-10 13:21:34 +02:00
Arian van Putten
fd26721feb Merge pull request #479 from rubenmoor/patch-1
Update examples.md: diener-monad
2016-04-29 11:24:01 +02:00
Sönke Hahn
e0216781b0 set the homepage to readthedocs 2016-04-22 14:12:21 +08:00
Sönke Hahn
b26bbfccda travis: enable -Wall -Werror 2016-04-21 13:06:10 +08:00
Ruben Moor
07f10aaf5e typos 2016-04-20 16:07:02 +02:00
Ruben Moor
292d49408a fixed formatting 2016-04-20 16:04:51 +02:00
Ruben Moor
69239393ad Update examples.md 2016-04-20 15:53:55 +02:00
Julian Arni
555038cbf4 Merge pull request #471 from haskell-servant/doc-examples
doc: add a section about example projects
2016-04-20 15:46:59 +02:00
Sönke Hahn
ab6131d733 version bump 2016-04-15 18:35:17 +08:00
Sönke Hahn
ef1561167d doc: add a section about example projects 2016-04-15 17:18:12 +08:00
Luke Cycon
21546991af Introduce a Handler alias for ExceptT ServantErr IO
Fixes #434
2016-04-11 22:27:29 -07:00
Luke Cycon
353c1798e1 Update some docs and the changelogs 2016-04-11 11:19:18 -07:00
Sönke Hahn
c2c9bef571 version bump 2016-04-07 18:24:29 +08:00
Sönke Hahn
14a8139cbe version bump 2016-04-04 16:22:11 +08:00
Alexander Kjeldaas
4f558971d1 Removed FromText references from docs. 2016-04-01 22:56:19 +02:00
mbg
a9200cd050 Modified the tutorial to reflect the changes to servant-client (explicit parameters) 2016-03-30 22:50:29 +01:00
mbg
19a4e037d8 Updated tutorial to reflect the updated client function in servant-client 2016-03-28 15:27:51 +01:00
Alp Mestanogullari
5b068b3ad3 Authentication.lhs in tutorial project + toc 2016-03-26 21:14:18 +01:00
Jonathan Curran
9c4aeec792 Add link to old tutorial 2016-03-22 08:32:15 -05:00
Aaron Levin
fbf7c02d73 Merge pull request #416 from haskell-servant/jkarni/basic-auth-tutorial
Add basic auth to tutorial
2016-03-20 22:21:25 +01:00
Julian K. Arni
4e37365534 Fix type-synonym in tutorial 2016-03-20 19:04:49 +01:00
Julian K. Arni
f742a5c4c8 Simplify auth section in apitypes 2016-03-19 18:15:29 +01:00
Julian K. Arni
45eba28da9 re-add conclusion 2016-03-19 17:26:52 +01:00
aaron levin
c22d74ca55 Add basic authentication to tutorial 2016-03-19 17:25:44 +01:00
Sönke Hahn
610b837e8d tutorial: html tweak 2016-03-19 17:40:00 +08:00
Julian K. Arni
4e90308b85 Fix compilation 2016-03-19 17:40:00 +08:00
Sönke Hahn
b97a352773 tutorial: updated Javascript.lhs (and wrote some tests for it) 2016-03-19 17:40:00 +08:00
rwobben
0985e51022 deleted the Trans.Monad.Except 2016-03-19 17:40:00 +08:00
Sönke Hahn
027cd82725 tutorial: corrected curl examples 2016-03-19 17:40:00 +08:00
rwobben
1b928878dd added aeson-compat to the cabal file 2016-03-19 17:40:00 +08:00
Sönke Hahn
8e4ab06030 tutorial: read through Docs.lhs 2016-03-19 17:40:00 +08:00
Sönke Hahn
ac02a28527 tutorial: formatting for bash sections 2016-03-19 17:40:00 +08:00
Sönke Hahn
2716d508e8 tutorial: read through Client.lhs 2016-03-19 17:40:00 +08:00
Sönke Hahn
e84fea334a tutorial: read through Server.lhs 2016-03-19 17:40:00 +08:00
rwobben
e68cf28750 change a dependency and delete EmptyConfig 2016-03-19 17:40:00 +08:00
Sönke Hahn
434c163aa1 tutorial: read through ApiType.lhs 2016-03-19 17:40:00 +08:00
Sönke Hahn
140da7a7b0 tutorial: tweaks 2016-03-19 17:40:00 +08:00
Sönke Hahn
71a21403a0 tutorial: tweak index page 2016-03-19 17:40:00 +08:00
Sönke Hahn
23d6671c6c tutorial: tweak some titles 2016-03-19 17:40:00 +08:00
Sönke Hahn
9263f9790f tutorial: restructuring 2016-03-19 17:40:00 +08:00
Julian K. Arni
5625f5273e more consistent line breaks 2016-03-19 17:40:00 +08:00
Julian K. Arni
0daa8048c4 Remove stale next/previous 2016-03-19 17:40:00 +08:00
Julian K. Arni
e1312c1bb6 sundry tutorial improvements 2016-03-19 17:40:00 +08:00
rwobben
9d2d7104d0 Changed so two titles are displayed correctly 2016-03-19 17:40:00 +08:00
Oleg Grenrus
73ab3062ab Use rst links syntax (it's not a markdown) 2016-03-19 17:40:00 +08:00
Sönke Hahn
487746f9e0 tutorial: make Javascript.lhs compile 2016-03-19 17:40:00 +08:00
Sönke Hahn
7445d56c68 tutorial: make Docs.lhs compile 2016-03-19 17:40:00 +08:00
Sönke Hahn
678d50796b tutorial: fix for ghc-7.8 2016-03-19 17:40:00 +08:00
Sönke Hahn
6cb529fc5f tutorial: added working .ghci 2016-03-19 17:40:00 +08:00
Sönke Hahn
a7424c4753 tutorial: make Server compile 2016-03-19 17:39:59 +08:00
Sönke Hahn
ad48c0efa6 tutorial: allow older ghcs in cabal file 2016-03-19 17:39:59 +08:00
Sönke Hahn
df363cecb0 tutorial: make Client.lhs compile 2016-03-19 17:39:59 +08:00
Andres Loeh
52b1a233fe Add / expand the documentation of the NoContent case. 2016-03-19 17:39:59 +08:00
Andres Loeh
21426a223e Rewrite the part on verbs. 2016-03-19 17:39:59 +08:00
Sönke Hahn
4fbf28c3c0 tutorial: add markdown-unlit as a cabal dependency 2016-03-19 17:39:59 +08:00
Sönke Hahn
207d51bbf9 docs: add documentation on how to build the docs locally 2016-03-19 17:39:59 +08:00
Sönke Hahn
c53945098d tutorial: compile during CI 2016-03-19 17:39:59 +08:00
Julian K. Arni
8990ebb16e Fix toctree and page titles 2016-03-19 17:39:59 +08:00
Julian K. Arni
8e63078691 compiling ApiType.lhs 2016-03-19 17:39:59 +08:00
Julian K. Arni
c6dfac5203 Remove matrix params 2016-03-19 17:39:59 +08:00
Julian K. Arni
f601cbf3b1 Fix cabal file, stack.yaml, and sources.txt 2016-03-19 17:39:59 +08:00
Julian K. Arni
a7c3880c67 Remove convert script 2016-03-19 17:39:59 +08:00
Julian K. Arni
8b1bf02af8 Remove bird-tracks 2016-03-19 17:39:59 +08:00
Julian K. Arni
7af73d63ea Explicit ignore 2016-03-19 17:39:59 +08:00
Julian K. Arni
5542ce8916 Start tutorial project 2016-03-19 17:39:59 +08:00
Julian K. Arni
62fffed1f1 Remove servant-examples 2016-03-19 17:39:59 +08:00
Sönke Hahn
1d4e3a1e5b Moved tutorial to servant-examples/tutorial and include it in doc/index.rst 2016-03-19 17:39:59 +08:00
Nickolay Kudasov
94e07f9519 Add basic configuration for Read The Docs (based on Stack's) 2016-03-19 17:39:59 +08:00