lib.metadata.extract

Title, Subtitle, and Metadata extraction of reStructuredText.

django_docutils.lib.metadata.extract.extract_title(document)

Return the title of the document.

Parameters:

document (docutils.nodes.document) – Document to return title for.

Returns:

Title of document or None if not found.

Return type:

str or None

django_docutils.lib.metadata.extract.extract_metadata(document)

Return the dict containing document metadata.

Parameters:

document (docutils.nodes.document) – Document extract metadata from.

Returns:

docinfo data from document

Return type:

dict

See also

From

https://github.com/adieu/mezzanine-cli @ mezzanine_cli/parser.py

License

BSD (https://github.com/adieu/mezzanine-cli/blob/master/setup.py)

django_docutils.lib.metadata.extract.extract_subtitle(document)

Return the subtitle of the document.

Return type:

Optional[str]

django_docutils.lib.metadata.extract.extract_abstract(doctree, length=100)

Pull first n words from a docutils document.

We use this to create snippets for Twitter Cards, FB, etc.

Parameters:

• doctree (docutils.nodes.document) – Document to extract abstract from.

• length (int) – Word count to cut content off at.

Returns:

truncated content, html tags removed

Return type:

str