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.

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)

Represents course metadata.

classmethod from_directory(dirpath)

Read manifest from content directory.

Parameters:dirpath (str) – Full path to content directory. Return type:Manifest Returns:Manifest object

classmethod from_yaml(yaml_data)

Create a manifest from YAML data.

Parameters:yaml_data (str) – YAML representation of a manifest Return type:Manifest Returns:Manifest object

class innoconv.manifest.ManifestEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

JSON encoder that can handle Manifest objects.

default(o)

Return dict for Manifest objects.