class documentation

class document(nodes.document):

View In Hierarchy

The document root element patched by Sphinx.

This fixes that document.set_id() does not support a node having multiple node Ids. see https://sourceforge.net/p/docutils/patches/167/

Important

This is only for Sphinx internal use. Please don't use this in your extensions. It will be removed without deprecation period.

Method set​_id Undocumented
def set_id(self, node, msgnode=None, suggested_prefix=''):

Undocumented

Parameters
node:ElementUndocumented
msgnode:ElementUndocumented
suggested​_prefix:strUndocumented
Returns
strUndocumented