| License | BSD-3-Clause |
|---|---|
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Swarm.Doc.Gen
Description
Auto-generation of various forms of documentation.
Synopsis
- generateDocs :: GenerateDocs -> IO ()
- data GenerateDocs where
- data EditorType
- data SheetType
- loadStandaloneScenario :: (Has (Throw SystemFailure) sig m, Has (Lift IO) sig m) => FilePath -> m (Scenario, (WorldMap, EntityMap, [Recipe Entity]))
- keywordsCommands :: EditorType -> Text
- keywordsDirections :: EditorType -> Text
- operatorNames :: Text
- builtinFunctionList :: EditorType -> Text
- data PageAddress = PageAddress {}
Main document generation function + types
generateDocs :: GenerateDocs -> IO () Source #
Generate the requested kind of documentation to stdout.
data GenerateDocs where Source #
An enumeration of the kinds of documentation we can generate.
Constructors
| RecipeGraph :: GenerateDocs | Entity dependencies by recipes. |
| EditorKeywords :: Maybe EditorType -> GenerateDocs | Keyword lists for editors. |
| SpecialKeyNames :: GenerateDocs | List of special key names recognized by |
| CheatSheet :: PageAddress -> Maybe SheetType -> GenerateDocs | Cheat sheets for inclusion on the Swarm wiki. |
| TutorialCoverage :: GenerateDocs | List command introductions by tutorial |
| WebAPIEndpoints :: GenerateDocs | Web API endpoints |
Instances
| Show GenerateDocs Source # | |
Defined in Swarm.Doc.Gen Methods showsPrec :: Int -> GenerateDocs -> ShowS # show :: GenerateDocs -> String # showList :: [GenerateDocs] -> ShowS # | |
| Eq GenerateDocs Source # | |
Defined in Swarm.Doc.Gen | |
data EditorType Source #
An enumeration of the editors supported by Swarm (currently, Emacs and VS Code).
Instances
| Bounded EditorType Source # | |
Defined in Swarm.Doc.Gen | |
| Enum EditorType Source # | |
Defined in Swarm.Doc.Gen 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 Source # | |
Defined in Swarm.Doc.Gen Methods showsPrec :: Int -> EditorType -> ShowS # show :: EditorType -> String # showList :: [EditorType] -> ShowS # | |
| Eq EditorType Source # | |
Defined in Swarm.Doc.Gen | |
An enumeration of the kinds of cheat sheets we can produce.
Constructors
| Entities | |
| Commands | |
| Capabilities | |
| Recipes | |
| Scenario |
Instances
| Bounded SheetType Source # | |
| Enum SheetType Source # | |
Defined in Swarm.Doc.Gen Methods succ :: SheetType -> SheetType # pred :: SheetType -> SheetType # fromEnum :: SheetType -> Int # enumFrom :: SheetType -> [SheetType] # enumFromThen :: SheetType -> SheetType -> [SheetType] # enumFromTo :: SheetType -> SheetType -> [SheetType] # enumFromThenTo :: SheetType -> SheetType -> SheetType -> [SheetType] # | |
| Show SheetType Source # | |
| Eq SheetType Source # | |
loadStandaloneScenario :: (Has (Throw SystemFailure) sig m, Has (Lift IO) sig m) => FilePath -> m (Scenario, (WorldMap, EntityMap, [Recipe Entity])) Source #
Formatted keyword lists
keywordsCommands :: EditorType -> Text Source #
Get formatted list of basic functions/commands.
keywordsDirections :: EditorType -> Text Source #
Get formatted list of directions.
operatorNames :: Text Source #
A list of the names of all the operators in the language.
builtinFunctionList :: EditorType -> Text Source #
Wiki pages
data PageAddress Source #
A configuration record holding the URLs of the various cheat sheets, to facilitate cross-linking.
Constructors
| PageAddress | |
Fields
| |
Instances
| Show PageAddress Source # | |
Defined in Swarm.Doc.Gen Methods showsPrec :: Int -> PageAddress -> ShowS # show :: PageAddress -> String # showList :: [PageAddress] -> ShowS # | |
| Eq PageAddress Source # | |
Defined in Swarm.Doc.Gen | |