abstract const class compilerDoc::DocEnv
DocEnv is the centralized glue class for managing documentation modeling and rendering:
- hooks for lookup and loading of spaces/pods
- hooks for theming HTML chrome and navigation
- hooks for renderering HTML pages
- hooks for hyperlink resolution
Resolve the link relative to the given from document. See
DocLinkfor the built-in formats.
Hook to perform extra DocLink checking such as links to NoDocs
Return URI used to link the from doc to the target doc. Also see
virtual Str? linkUriExt()
Return the file extension (including the dot) to suffix all link URIs. Default returns ".html"
Render the given document to the specified output stream. Default implementation uses
Lookup a space by its space name. If not found then return null or raise UnknownDocErr. This method is called frequently during document rendering and linking so caching is expected.
virtual DocTheme theme()
Theme is responsible for the common chrome, styling, and navigation during rendering
virtual DocTopIndex topIndex()
Get the document which represents top level index.