5synopsis: generate API docs for your servant webservice
8 Library for generating API docs from a servant API definition.
10 Runnable example <https://github.com/haskell-servant/servant/blob/master/servant-docs/example/greet.hs here>.
12 <https://github.com/haskell-servant/servant/blob/master/servant-docs/CHANGELOG.md CHANGELOG>
14homepage: http://docs.servant.dev/
15bug-reports: http://github.com/haskell-servant/servant/issues
18author: Servant Contributors
19maintainer: haskell-servant-maintainers@googlegroups.com
20copyright: 2014-2016 Zalora South East Asia Pte Ltd, 2016-2019 Servant Contributors
22tested-with: GHC ==8.6.5 || ==8.8.4 || ==8.10.2 || ==9.0.1
27 golden/comprehensive.md
31 location: http://github.com/haskell-servant/servant.git
36 , Servant.Docs.Internal
37 , Servant.Docs.Internal.Pretty
39 -- Bundled with GHC: Lower bound to not force re-installs
40 -- text and mtl are bundled starting with GHC-8.4
42 -- note: mtl lower bound is so low because of GHC-7.8
45 , bytestring >= 0.10.8.1 && < 0.12
46 , text >= 1.2.3.0 && < 1.3
48 -- Servant dependencies
50 servant >= 0.18 && <0.20
52 -- Other dependencies: Lower bound around what is in the latest Stackage LTS.
53 -- Here can be exceptions if we really need features from the newer versions.
55 aeson >= 1.4.1.0 && < 3
56 , aeson-pretty >= 0.8.5 && < 0.9
57 , base-compat >= 0.10.5 && < 0.12
58 , case-insensitive >= 1.2.0.11 && < 1.3
59 , hashable >= 1.2.7.0 && < 1.4
60 , http-media >= 0.7.1.3 && < 0.9
61 , http-types >= 0.12.2 && < 0.13
62 , lens >= 4.17 && < 5.1
63 , string-conversions >= 0.4.0.1 && < 0.5
64 , universe-base >= 1.1.1 && < 1.2
65 , unordered-containers >= 0.2.9.0 && < 0.3
68 default-language: Haskell2010
69 ghc-options: -Wall -Wno-redundant-constraints
73 hs-source-dirs: example
83 default-language: Haskell2010
86 default-language: Haskell2010
87 type: exitcode-stdio-1.0
89 other-modules: Servant.DocsSpec
93 -- Dependencies inherited from the library. No need to specify bounds.
103 -- Additional dependencies
105 tasty >= 1.1.0.4 && < 1.5,
106 tasty-golden >= 2.3.2 && < 2.4,
107 tasty-hunit >= 0.10.0.1 && < 0.11,
108 transformers >= 0.5.2.0 && < 0.6
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list