Many

Many()

A section of the documentation that outputs to multiple files.

See the design for an explanation of the design of Many. See the guide on how to set up custom styles and sections. See Config for more details on the top-level settings and Content for more details on the content items.

Attributes

output_path : Optional[RelativePath]

The output path for the section relative to Config.output_dir. If a directory is provided, the output files will be saved in that directory. If the path includes a placeholder in curly brackets (e.g. resources/{resource-name}.qmd), the output files will be named following this template.

content : ManyContent

The content item to display in this section; choices are resources and fields.

template_path : TemplatePath

See Content.template_path for more details.

jinja_variable : str

See Content.jinja_variable for more details.

Examples

import seedcase_flower as fl
from pathlib import Path

# A section that displays each resource in a separate file within the
# `resources/` folder.
section = fl.Many(
    output_path=Path("resources/"),
    content=fl.ManyContent.resources,
    template_path=Path("resource.md.jinja"),
    jinja_variable="resource",
)