sphinx.environment.collectors.metadata.MetadataCollector

class documentation

class MetadataCollector(EnvironmentCollector): (source)

metadata collector for sphinx.environment.

Method	`clear_doc`	Remove specified data of a document.
Method	`merge_other`	Merge in specified data regarding docnames from a different `BuildEnvironment` object which coming from a subprocess in parallel builds.
Method	`process_doc`	Process the docinfo part of the doctree as metadata.

Method	`disable`	Undocumented
Method	`enable`	Undocumented
Method	`get_outdated_docs`	Return a list of docnames to re-read.
Method	`get_updated_docs`	Return a list of docnames to re-read.
Instance Variable	`listener_ids`	Undocumented

def clear_doc(self, app, env, docname): (source) ¶

overrides sphinx.environment.collectors.EnvironmentCollector.clear_doc

Remove specified data of a document. This method is called on the removal of the document.

def merge_other(self, app, env, docnames, other): (source) ¶

overrides sphinx.environment.collectors.EnvironmentCollector.merge_other

Merge in specified data regarding docnames from a different `BuildEnvironment` object which coming from a subprocess in parallel builds.

def process_doc(self, app, doctree): (source) ¶

overrides sphinx.environment.collectors.EnvironmentCollector.process_doc

Process the docinfo part of the doctree as metadata. Keep processing minimal -- just return what docutils says.