Merge pull request #58 from haskell-servant/jkarni/remove-serveDocumentation

remove serveDocumentation references/code
2015-05-06 17:42:52 +02:00 · 2015-05-06 17:42:52 +02:00 · 09d901d87c
commit 09d901d87c
parent a058cd4bf4 1631ae644c
2 changed files with 1 additions and 29 deletions
--- a/servant-docs/src/Servant/Docs/Internal.hs
+++ b/servant-docs/src/Servant/Docs/Internal.hs
@ -876,30 +876,3 @@ instance (KnownSymbol path, HasDocs sublayout) => HasDocs (path :> sublayout) wh
          endpoint' = endpoint & path <>~ [symbolVal pa]
          pa = Proxy :: Proxy path

-{-
-
-- | Serve your API's docs as markdown embedded in an html \<pre> tag.
--
-- > type MyApi = "users" :> Get [User]
-- >         :<|> "docs   :> Raw
-- >
-- > apiProxy :: Proxy MyApi
-- > apiProxy = Proxy
-- >
-- > server :: Server MyApi
-- > server = listUsers
-- >     :<|> serveDocumentation apiProxy
-serveDocumentation :: HasDocs api => Proxy api -> Server Raw
-serveDocumentation proxy _request respond =
-  respond $ responseLBS ok200 [] $ cs $ toHtml $ markdown $ docs proxy
-
-toHtml :: String -> String
-toHtml md =
-  "<html>" ++
-  "<body>" ++
-  "<pre>" ++
-  md ++
-  "</pre>" ++
-  "</body>" ++
-  "</html>"
-}
--- a/servant/src/Servant/API/Raw.hs
+++ b/servant/src/Servant/API/Raw.hs
@ -10,6 +10,5 @@ import Data.Typeable (Typeable)
 --
 -- In addition to just letting you plug in your existing WAI 'Application's,
 -- this can also be used with 'Servant.Utils.StaticFiles.serveDirectory' to serve
-- static files stored in a particular directory on your filesystem, or to serve
-- your API's documentation with 'Servant.Utils.StaticFiles.serveDocumentation'.
+-- static files stored in a particular directory on your filesystem
 data Raw deriving Typeable