API Reference

What the API reference is in your project

The API reference is the part of the site Folio generates from source. List your source roots under source.python.paths, source.javascript.paths or source.rust.paths in docs.yaml; every module becomes one page, and each page shows:

• the module’s doc comment as prose;
• every public class, function and type with its signature, including type annotations, defaults, decorators and Rust attributes (a Python signature leaves out self and cls and takes an unannotated parameter’s type from its docstring);
• a parameter table and return type per Python and JavaScript function, read from the signature and from Google or NumPy docstrings (with auto also reading reStructuredText and epydoc fields) or JSDoc tags; a Rust function shows its signature and doc comment, as rustdoc does;
• the raises, examples and notes of a docstring, and its deprecated, warning, see also, references and todo sections as labelled paragraphs;
• module constants, class attributes, struct fields and enum variants in tables, and JavaScript and Rust re-exports listed as written, without resolving what they point at.

Languages lists what each reader takes from its source and where it stops.

Folio reads the source and never executes it. Each generated page also gets an agent-readable Markdown mirror, so agents read the same reference people do.

Quick Start walks the first build end to end, and Configuration documents the source block.