OPENFPDocsall docsSearch names, modules, packages, or :: a typeCtrl K

GHC 10.0.0.20260917

Package0.10.0.1Documentation

mackerel-dsl

The mackerel language: the documentation model, haddock's anchors, the search index and the docs.vx site theory

Modules

14 modules
  • Mackerel.Anchor13Haddock's file names and anchors, kept byte for byte so links already
  • Mackerel.Cache10A binary cache a docs root names: the substituter and the key its
  • Mackerel.Error2What can stop a mackerel run, and how it reads to a person.
  • Mackerel.Flake8A package set's flake input, as a reader pastes it into a flake.nix:
  • Mackerel.Ir57The documentation model: a package's modules, their export structure,
  • Mackerel.Nix2A Nix binding held as a term and printed with its keys and string
  • Mackerel.Pass8A pass as read: everything a renderer needs to write a pass's sites,
  • Mackerel.Plan6A docs.vx program split into the passes a build renders one at a
  • Mackerel.Search26The search index a site ships for its palette: a generated foreign
  • Mackerel.Site29The scope a docs.vx program is elaborated in: its export list is the
  • Mackerel.Site.Effects54The Site theory a docs.vx program speaks: which package sets and
  • Mackerel.Switch8Switching between sites, such as two revisions of one package set:
  • Mackerel.Theory12Views derived from the model, never stored: an effect GADT paired with
  • Mackerel.Url7Where pages live in the docs tree, and the relative URLs between them.

Description

The values mackerel speaks and the language a docs.vx program is written in. Mackerel.Ir is the documentation model, independent of the GHC that wrote the interfaces; Mackerel.Anchor keeps haddock's file names and anchors byte for byte; Mackerel.Url relates pages across sibling sites; Mackerel.Search is the palette's index; Mackerel.Theory pairs effect GADTs with their verbs; Mackerel.Site is the scope a docs.vx program is elaborated in; Mackerel.Pass is the IR a pass is read into, versioned, between the reader and the renderer. Nothing here performs IO.

Depends on

8 packages
  • aeson-2.3.2.0in this set
  • base-4.23.0.0with GHC
  • binary-0.8.9.3with GHC
  • bytestring-0.12.2.0with GHC
  • containers-0.8with GHC
  • deepseq-1.5.2.0with GHC
  • polysemy-1.9.2.0in this set
  • text-2.1.4with GHC

Used by in this set · 0

Nothing in this set depends on it.