pod compilerDoc

Compiler to model and generate API docs

Mixins

DocCrawler

DocCrawler provides an interface to implement by search engine crawlers when crawling a specific document via Doc.onCrawl.

Classes

Doc

Doc is the base class for document types.

DocChapter

DocChapter models a fandoc "chapter" in a manual like docLang

DocChapterRenderer

Renders DocChapter documents

DocEnv

DocEnv is the centralized glue class for managing documentation modeling and rendering

DocErrHandler

DocErrHandler is responsible for handling errors encountered during doc compilation including broken links and fandoc format errors.

DocFacet

DocFacet models the documentation of a Facet on a type or slot.

DocFandoc

Wrapper for Fandoc string for a chapter, type, or slot

DocField

DocField models the documentation of a Field.

DocFlags

DocFlags models the flags used to annotate types and slots

DocHeading

DocHeader models a heading in a table of contents for pod/chapter.

DocLink

DocLink models a link between two documents.

DocLoc

DocLoc models a filename / linenumber

DocMethod

DocMethod models the documentation of a Method.

DocParam

DocParam models the documentation of a Param

DocPod

DocPod models the documentation of a Pod.

DocPodIndex

DocPodIndex represents the index document of a DocPod.

DocPodIndexRenderer

Renders the index of a pod's documents.

DocRenderer

DocRenderer is base class for rendering a Doc.

DocRes

DocRes models a resource file within a pod.

DocSlot

DocSlot models the documentation of a Slot.

DocSpace

DocSpace manages a namespace of documents.

DocSrc

DocSrc models a page of source code for display.

DocSrcRenderer

Renders DocSrc documents.

DocTheme

DocTheme is responsible for providing the common chrome, styling, and breadcrumb across different DocRenderers.

DocTopIndex

DocTopIndex models the top-level index

DocTopIndexRenderer

Renders the index of a pod's documents

DocType

DocType models the documentation of a Type.

DocTypeRef

DocTypeRef models a type reference in a type or slot signature.

DocTypeRenderer

Renders DocType documents

Errs

DocErr

DocErr models errors and their locations during doc compilation.

UnknownDocErr

UnknownDocErr is raised when resolving a non-existent document.