lib.metadata.process

Metadata is a catch-all term for information for an RST document.

It can be pulled from the RST file itself, such as:

• The Title/Subtitle of the document

• The docinfo attributes

In the case of directory-style projects, the manifest.json.

These optional pipeline functions can be configured to to create, read, update, and delete metadata from RST projects.

To set metadata processors, use DJANGO_DOCUTILS_LIB_RST[‘metadata_processors’]:

DJANGO_DOCUTILS_LIB_RST = {
    'metadata_processors': [
        'django_docutils.lib.metadata.processors.process_datetime'
    ],
}

The order of the processors will be respected.

The function accepts one argument, the metadata dictionary, and returns the same dictionary:

def process_datetime(metadata):
    # create, read, update, delete metadata from the RST document
    return metadata

See processors.py for more examples.

django_docutils.lib.metadata.process.process_metadata(metadata)

Return objects from RST metadata pulled from document source.

This will turn things like string dates into time-zone’d dateutil objects.

Parameters:

metadata (dict) – Data returned from processing an RST file

Returns:

Metadata from rst file.

Return type:

dict