Content

Content()

Content to include within a One section.

The Content class defines what Data Package properties and Jinja2 template file belong within a specific section (an output file) in the documentation. You can use this class to customise how different parts of the datapackage.json file are displayed in the documentation and to create common presets when styles share similar content structures.

Attributes

jsonpath : str

The JSON path, expressed using JSON path syntax, to the Data Package property that should be sent to the template_path Jinja2 file.

template_path : TemplatePath

The path to the Jinja2 template file for this content item, relative to Config.template_dir.

jinja_variable : str

The Jinja2 variable name that will be used in the template to reference this content item.

Examples

import seedcase_flower as fl
from pathlib import Path

# A content item displaying the metadata of the whole package
package_content = fl.Content(
    jsonpath="$",
    template_path=Path("package.qmd.jinja"),
    jinja_variable="package",
)