gendocs

Library for generating interface documentation from types https://github.com/seanhess/gendocs#readme

Latest on Hackage:0.1.3

This package is not currently in any snapshots. If you're interested in using it, we recommend adding it to Stackage Nightly. Doing so will make builds more reliable, and allow stackage.org to host generated Haddocks.

BSD3 licensed by Sean Hess
Maintained by seanhess@gmail.com

Generate interface documentation for your types

Example

{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
module Example where

import Data.Aeson (ToJSON)
import Data.Proxy (Proxy(..))
import Data.Docs (markdown, Docs(..), Sample(..), genDocs, genDocsEnum)
import Data.Text (Text)
import qualified Data.Text as Text
import GHC.Generics (Generic)

data Person = Person
    { name :: Text
    , age :: Age
    , hobbies :: [Hobby]
    } deriving (Show, Eq, Generic)
instance ToJSON Person
instance Docs Person
instance Sample Person where
    sample _ = Person
      { name = "Bob"
      , age = sample (Proxy :: Proxy Age)
      , hobbies = [Haskell, Friends]
      }

newtype Age = Age Int
    deriving (Show, Eq, Generic)
instance ToJSON Age
instance Docs Age where
    docs = genDocs "Age in years"
instance Sample Age where
    sample _ = Age 31
    samples _ = [Age 31, Age 24]

data Hobby = Haskell | Friends | Movies
    deriving (Show, Eq, Generic, Enum, Bounded)
instance ToJSON Hobby
instance Docs Hobby where
    docs = genDocsEnum "Hobby"
instance Sample Hobby where
    sample _ = Haskell

doc :: IO ()
doc = do
    putStrLn $ Text.unpack json

json :: Text
json = Text.intercalate "\n\n\n" $
  [ markdown (Proxy :: Proxy Person)
  , markdown (Proxy :: Proxy Age)
  , markdown (Proxy :: Proxy Hobby)
  ]

This generates the following output

Person
---------------------

| Field   | Type              |
|---------|-------------------|
| name    | [Text](#text)     |
| age     | [Age](#age)       |
| hobbies | [[Hobby]](#hobby) |

```
{
    "age": 31,
    "hobbies": [
        "Haskell",
        "Friends"
    ],
    "name": "Bob"
}
```


Age
---------------------

Age in years

```
31
```


Hobby
---------------------

| Values    |
|-----------|
| "Haskell" |
| "Friends" |
| "Movies"  |

```
"Haskell"
```
comments powered byDisqus