idris-0.9.17.1: Functional Programming Language with Dependent Types

Safe HaskellNone
LanguageHaskell98

Idris.IdrisDoc

Description

Generation of HTML documentation for Idris code

Synopsis

Documentation

generateDocs Source

Arguments

:: IState

IState where all necessary information is extracted from.

-> [Name]

List of namespaces to generate documentation for.

-> FilePath

The directory to which documentation will be written.

-> IO (Either String ()) 

Generates HTML documentation for a series of loaded namespaces and their dependencies.