Swarm.Doc.Gen

Auto-generation of various forms of documentation.

Main document generation function + types

generateDocs :: GenerateDocs -> IO ()

Generate the requested kind of documentation to stdout.

data GenerateDocs where

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.

TutorialCoverage :: GenerateDocs

List command introductions by tutorial

Instances

Show GenerateDocs

Defined in Swarm.Doc.Gen

Methods

showsPrec :: Int -> GenerateDocs -> ShowS

show :: GenerateDocs -> String

showList :: [GenerateDocs] -> ShowS

Eq GenerateDocs

Defined in Swarm.Doc.Gen

Methods

(==) :: GenerateDocs -> GenerateDocs -> Bool

(/=) :: GenerateDocs -> GenerateDocs -> Bool

data SheetType

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

Constructors

Entities

Terrain

Commands

CommandMatrix

Capabilities

Recipes

Scenario

Instances

Bounded SheetType

Defined in Swarm.Doc.Wiki.Cheatsheet

Methods

minBound :: SheetType

maxBound :: SheetType

Enum SheetType

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

Defined in Swarm.Doc.Wiki.Cheatsheet

Methods

showsPrec :: Int -> SheetType -> ShowS

show :: SheetType -> String

showList :: [SheetType] -> ShowS

Eq SheetType

Defined in Swarm.Doc.Wiki.Cheatsheet

Methods

(==) :: SheetType -> SheetType -> Bool

(/=) :: SheetType -> SheetType -> Bool

Wiki pages

data PageAddress

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

Show PageAddress

Defined in Swarm.Doc.Wiki.Cheatsheet

Methods

showsPrec :: Int -> PageAddress -> ShowS

show :: PageAddress -> String

showList :: [PageAddress] -> ShowS

Eq PageAddress

Defined in Swarm.Doc.Wiki.Cheatsheet

Methods

(==) :: PageAddress -> PageAddress -> Bool

(/=) :: PageAddress -> PageAddress -> Bool

Recipe graph data

data RecipeGraphData

Constructors

RecipeGraphData

Fields

• rgWorldEntities :: Set Entity
• rgStartingDevices :: Set Entity
• rgStartingInventory :: Set Entity
• rgLevels :: [Set Entity]
• rgAllEntities :: Set Entity
• rgRecipes :: [Recipe Entity]

data EdgeFilter

Constructors

NoFilter

FilterForward

FilterNext

Instances

Show EdgeFilter

Defined in Swarm.Doc.Gen

Methods

showsPrec :: Int -> EdgeFilter -> ShowS

show :: EdgeFilter -> String

showList :: [EdgeFilter] -> ShowS

Eq EdgeFilter

Defined in Swarm.Doc.Gen

Methods

(==) :: EdgeFilter -> EdgeFilter -> Bool

(/=) :: EdgeFilter -> EdgeFilter -> Bool

classicScenarioRecipeGraphData :: IO RecipeGraphData

ignoredEntities :: Set Text

Ignore utility entities that are just used for tutorials and challenges.