weave()

Produce documentation from a literate source.

Usage

weave(source)

The literate programming model this implements is due to Knuth (Knuth 1984); this docstring citation probes whether project-level bibliography resolution reaches generated API reference pages.

Parameters

source: str

The literate program source.

Returns

str

The woven documentation.

References

Knuth, Donald E. 1984. “Literate Programming.” The Computer Journal 27 (2): 97–111.