doc2go

doc2go generates static HTML documentation from one or more Go packages.

doc2go

doc2go generates static HTML documentation from one or more Go packages.

See https://abhinav.github.io/doc2go/ for information on how to use it.

Directories

internal/errdeferPackage errdefer provides functions for running operations that must be deferred until the end of a function, but which may return errors that should be returned from the function.
internal/flagvaluePackage flagvalue provides flag.Value implementations.
internal/godocPackage godoc provides the means of converting parsed Go source information into a documentation subset of it.
internal/gosrcPackage gosrc is the part of the pipeline of doc2go responsible for finding Go packages and loading information about them.
internal/highlightPackage highlight provides support to highlight source code blocks.
internal/htmlPackage html renders HTML from godoc.Package.
internal/iotestPackage iotest provides utilities for testing IO-related code.
internal/linebufPackage linebuf provides line-buffered IO utilities.
internal/mustPackage must provides helper functions to assert program invariants.
internal/pagefindPackage pagefind provides access to the pagefind CLI.
internal/pathtreePackage pathtree provides a data structure that stores values organized under a tree-like hierarchy where values from higher levels cascade down to lower levels unless the lower levels define their own values.
internal/pathxPackage pathx provides extensions to the path package.
internal/ptrPackage ptr provides Of, to turn literals into pointers.
internal/relativePackage relative turns paths and file paths relative with string manipulation exclusively.
internal/sliceutilPackage sliceutil contains generic functions for working with slices.