sphinx_packaging.toml

Sphinx extension which adds the toml role for referencing sections of the TOML specification.

Classes:

TOML()

Sphinx role for referencing a section of the TOML specification.

Functions:

setup(app)

Setup sphinx_packaging.toml.

class TOML

Bases: ReferenceRole

Sphinx role for referencing a section of the TOML specification.

Methods:

build_uri()	Constrict the target URI for the reference node.
run()	Process the role.

build_uri()

Constrict the target URI for the reference node.

Return type:

str

has_explicit_title

Type:    bool

run()

Process the role.

Return type:

Tuple[List[Node], List[system_message]]

target

Type:    str

title

Type:    str

setup(app)

Setup sphinx_packaging.toml.

Parameters:

app (Sphinx) – The Sphinx application.

Return type:

Dict[str, Any]