tfdocs.parser.Metadata

View source on GitHub

A class for building a page's Metadata block.

tfdocs.parser.Metadata(
    name, version=None, content=None
)

Args
name	The name of the page being described by the Metadata block.
version	The source version.
content	Content to create the metadata from.

Attributes
name	The name of the page being described by the Metadata block.
version	The source version.

Methods

append

View source

append(
    item
)

Adds an item from the page to the Metadata block.

Args
item	The parsed page section to add.

build_html

View source

build_html()

Returns the Metadata block as an Html string.