Swarm.Doc.Gen

Contents

Description

Auto-generation of various forms of documentation.

Synopsis

Main document generation function + types

Generate the requested kind of documentation to stdout.

An enumeration of the kinds of documentation we can generate.

Constructors

RecipeGraph :: EdgeFilter -> GenerateDocs	Entity dependencies by recipes.
EditorKeywords :: Maybe EditorType -> GenerateDocs	Keyword lists for editors.
SpecialKeyNames :: GenerateDocs	List of special key names recognized by `Key` command
CheatSheet :: PageAddress -> SheetType -> GenerateDocs	Cheat sheets for inclusion on the Swarm wiki.
CommandsData :: GenerateDocs	JSON representation of commands metadata matrix
TutorialCoverage :: GenerateDocs	List command introductions by tutorial

Instances details

Show GenerateDocs Source #
Instance details Defined in Swarm.Doc.Gen Methods showsPrec :: Int -> GenerateDocs -> ShowS # show :: GenerateDocs -> String # showList :: [GenerateDocs] -> ShowS #
Eq GenerateDocs Source #
Instance details Defined in Swarm.Doc.Gen Methods (==) :: GenerateDocs -> GenerateDocs -> Bool # (/=) :: GenerateDocs -> GenerateDocs -> Bool #

An enumeration of the kinds of cheat sheets we can produce.

Constructors

Instances details

Bounded SheetType Source #
Instance details Defined in Swarm.Doc.Wiki.Cheatsheet Methods minBound :: SheetType # maxBound :: SheetType #
Enum SheetType Source #
Instance details Defined in Swarm.Doc.Wiki.Cheatsheet Methods succ :: SheetType -> SheetType # pred :: SheetType -> SheetType # toEnum :: Int -> SheetType # fromEnum :: SheetType -> Int # enumFrom :: SheetType -> [SheetType] # enumFromThen :: SheetType -> SheetType -> [SheetType] # enumFromTo :: SheetType -> SheetType -> [SheetType] # enumFromThenTo :: SheetType -> SheetType -> SheetType -> [SheetType] #
Show SheetType Source #
Instance details Defined in Swarm.Doc.Wiki.Cheatsheet Methods showsPrec :: Int -> SheetType -> ShowS # show :: SheetType -> String # showList :: [SheetType] -> ShowS #
Eq SheetType Source #
Instance details Defined in Swarm.Doc.Wiki.Cheatsheet Methods (==) :: SheetType -> SheetType -> Bool # (/=) :: SheetType -> SheetType -> Bool #

Wiki pages

A configuration record holding the URLs of the various cheat sheets, to facilitate cross-linking.

Constructors

PageAddress
Fields entityAddress :: Text commandsAddress :: Text capabilityAddress :: Text recipesAddress :: Text

Instances details

Show PageAddress Source #
Instance details Defined in Swarm.Doc.Wiki.Cheatsheet Methods showsPrec :: Int -> PageAddress -> ShowS # show :: PageAddress -> String # showList :: [PageAddress] -> ShowS #
Eq PageAddress Source #
Instance details Defined in Swarm.Doc.Wiki.Cheatsheet Methods (==) :: PageAddress -> PageAddress -> Bool # (/=) :: PageAddress -> PageAddress -> Bool #

Constructors

Instances details

Show EdgeFilter Source #
Instance details Defined in Swarm.Doc.Gen Methods showsPrec :: Int -> EdgeFilter -> ShowS # show :: EdgeFilter -> String # showList :: [EdgeFilter] -> ShowS #
Eq EdgeFilter Source #
Instance details Defined in Swarm.Doc.Gen Methods (==) :: EdgeFilter -> EdgeFilter -> Bool # (/=) :: EdgeFilter -> EdgeFilter -> Bool #