drasil-website-0.1.0.0: Using the Drasil generators to create Drasil's website
Safe HaskellSafe-Inferred
LanguageHaskell2010

Drasil.Website.Body

Description

Gathers and organizes all the information for the Drasil website.

Synopsis

Documentation

data FolderLocation Source #

Folder locations based on environment variables (using getEnv in Drasil.Website.Main).

Constructors

Folder 

Fields

  • depL :: FilePath

    Deploy location. Currently unused, but may be needed in the future.

  • docsRt :: FilePath

    Haddock documentation root file path. After using make deploy, this should be deploy/docs.

  • exRt :: FilePath

    Example root file path. After using make deploy, this should be deploy/examples.

  • graphRt :: FilePath

    Package dependency graph root file path. After using make deploy, this should be deploy/graphs.

  • analysisRt :: FilePath

    Analysis root file path. After using make deploy, this should be deploy/analysis.

  • typeGraphFolder :: FilePath

    Type graphs root file path. After using make deploy, this should be deploy/analysis/TypeDependencyGraphs.

  • classInstFolder :: FilePath

    Class-instance graphs root file path. After using make deploy, this should be deploy/analysis/DataTable/packagegraphs.

  • repoRt :: FilePath

    Repository root, used for linking to generated code in GitHub.

  • buildNum :: FilePath

    Deploy build number. Currently unused.

  • buildPth :: FilePath

    Deploy build path. Currently unused.

  • packages :: [String]

    List of Drasil packages taken from the Makefile.

si :: FolderLocation -> System Source #

System information.

symbMap :: ChunkDB Source #

Needed for references and terms to work.

gitHubRef :: Reference Source #

Used for the repository link.

sections :: FolderLocation -> [Section] Source #

Puts all the sections in order. Basically the website version of the SRS declaration.

websiteTitle :: String Source #

Hardcoded info for the title, URL, and image path.