Swarm.DocGen

Documentation

generateDocs :: GenerateDocs -> IO ()

data GenerateDocs where

Constructors

RecipeGraph :: GenerateDocs

Entity dependencies by recipes.

EditorKeywords :: Maybe EditorType -> GenerateDocs

Keyword lists for editors.

CheatSheet :: PageAddress -> Maybe SheetType -> GenerateDocs

Instances

Show GenerateDocs

Defined in Swarm.DocGen

Methods

showsPrec :: Int -> GenerateDocs -> ShowS

show :: GenerateDocs -> String

showList :: [GenerateDocs] -> ShowS

Eq GenerateDocs

Defined in Swarm.DocGen

Methods

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

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

data EditorType

Constructors

Emacs

VSCode

Instances

Bounded EditorType

Defined in Swarm.DocGen

Methods

minBound :: EditorType

maxBound :: EditorType

Enum EditorType

Defined in Swarm.DocGen

Methods

succ :: EditorType -> EditorType

pred :: EditorType -> EditorType

toEnum :: Int -> EditorType

fromEnum :: EditorType -> Int

enumFrom :: EditorType -> [EditorType]

enumFromThen :: EditorType -> EditorType -> [EditorType]

enumFromTo :: EditorType -> EditorType -> [EditorType]

enumFromThenTo :: EditorType -> EditorType -> EditorType -> [EditorType]

Show EditorType

Defined in Swarm.DocGen

Methods

showsPrec :: Int -> EditorType -> ShowS

show :: EditorType -> String

showList :: [EditorType] -> ShowS

Eq EditorType

Defined in Swarm.DocGen

Methods

(==) :: EditorType -> EditorType -> Bool

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

data SheetType

Constructors

Entities

Commands

Capabilities

Recipes

Instances

Bounded SheetType

Defined in Swarm.DocGen

Methods

minBound :: SheetType

maxBound :: SheetType

Enum SheetType

Defined in Swarm.DocGen

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.DocGen

Methods

showsPrec :: Int -> SheetType -> ShowS

show :: SheetType -> String

showList :: [SheetType] -> ShowS

Eq SheetType

Defined in Swarm.DocGen

Methods

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

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

Formatted keyword lists

keywordsCommands :: EditorType -> Text

Get formatted list of basic functions/commands.

keywordsDirections :: EditorType -> Text

Get formatted list of directions.

operatorNames :: Text

builtinFunctionList :: EditorType -> Text

editorList :: EditorType -> [Text] -> Text

Wiki pages

data PageAddress

Constructors

PageAddress

Fields

• entityAddress :: Text
• commandsAddress :: Text
• capabilityAddress :: Text
• recipesAddress :: Text

Instances

Show PageAddress

Defined in Swarm.DocGen

Methods

showsPrec :: Int -> PageAddress -> ShowS

show :: PageAddress -> String

showList :: [PageAddress] -> ShowS

Eq PageAddress

Defined in Swarm.DocGen

Methods

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

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

commandsPage :: Text

capabilityPage :: PageAddress -> EntityMap -> Text

noPageAddresses :: PageAddress