Crate forc_doc

Modules

doc

Handles conversion of compiled typed Sway programs into Documents that can be rendered into HTML.

render

Renders Documentation to HTML.

search

Structs

Command

Forc plugin for building a Sway package’s documentation

DocContext

RenderPlan

Information passed to the render phase to get TypeInfo, CallPath or visibility for type anchors.

Enums

DocResult

Result of documentation generation, either for a single package or a workspace.

Constants

ASSETS_DIR_NAME

DOC_DIR_NAME

Functions

compile

compile_html

examples

generate_docs

Generate documentation for a given package or workspace.