innoconv.manifest

The manifest comprises course metadata.

A manifest.yml file needs to exist in every course content and resides at the content root directory.

There is also a representation in JSON format. It is generated automatically by the extension WriteManifest and copied to the output folder.

Other extensions may add custom fields to the output manifest by implementing a method manifest_fields(). It needs to return a dict that is merged into the manifest.

A manifest.yml is written by course authors while the manifest.json is generated by the converter and used by innoconv-compatible viewers. The included information for both versions differ.

Example

title:
  en: Example title
  de: Beispiel-Titel
languages: en,de
class innoconv.manifest.Manifest(data)[source]

Represents course metadata.

Parameters

data (dict) – A dict with the manifest fields as keys

classmethod from_directory(dirpath)[source]

Read manifest from content directory.

Parameters

dirpath (str) – Full path to content directory.

Return type

Manifest

Returns

Manifest object

classmethod from_yaml(yaml_data)[source]

Create a manifest from YAML data.

Parameters

yaml_data (str) – YAML representation of a manifest

Return type

Manifest

Returns

Manifest object