| Copyright | (c) 2024 Patrick Brisbin |
|---|---|
| License | AGPL-3 |
| Maintainer | pbrisbin@gmail.com |
| Stability | experimental |
| Portability | POSIX |
| Safe Haskell | None |
| Language | GHC2021 |
Ronn
Description
Synopsis
- module Ronn.AST
- module Ronn.Render
- ronnFilePath :: Ronn -> FilePath
- class HasSections (p :: k -> Type) where
- getSynopsis :: forall (a :: k). p a -> Maybe [Part]
- getOptDefinitions :: forall (a :: k). p a -> Maybe [Definition]
- getCmdDefinitions :: forall (a :: k). p a -> Maybe [Definition]
- getEnvDefinitions :: forall (a :: k). p a -> Maybe [Definition]
- getSections :: forall {k} p (a :: k). HasSections p => Text -> p a -> [Section]
- synopsisSection :: Text -> [Part] -> Section
- seeAlsoSection :: [ManRef] -> Section
- oneLineSection :: Text -> [Part] -> Section
- definitionsSection :: Text -> [Definition] -> Section
Documentation
module Ronn.AST
module Ronn.Render
ronnFilePath :: Ronn -> FilePath Source #
Parser-based sections
class HasSections (p :: k -> Type) where Source #
Parser types can be made an instance of this for use with getSections
Minimal complete definition
Nothing
Methods
getSynopsis :: forall (a :: k). p a -> Maybe [Part] Source #
Options parsers should produce [-f|--foo] --bar synopsis parts
getOptDefinitions :: forall (a :: k). p a -> Maybe [Definition] Source #
Options parsers should produce a list of option/help definitions
getCmdDefinitions :: forall (a :: k). p a -> Maybe [Definition] Source #
Options parsers should produce a list of command/help definitions
getEnvDefinitions :: forall (a :: k). p a -> Maybe [Definition] Source #
Environment parsers should produce a list of variable/help definitions
getSections :: forall {k} p (a :: k). HasSections p => Text -> p a -> [Section] Source #
Higher-level builders
seeAlsoSection :: [ManRef] -> Section Source #
definitionsSection :: Text -> [Definition] -> Section Source #