sphinx.addnodes.desc

class documentation

class desc(nodes.Admonition, nodes.Element):

View In Hierarchy

Node for a list of object signatures and a common description of them.

Contains one or more desc_signature nodes and then a single desc_content node.

This node always has two classes:

  • The name of the domain it belongs to, e.g., py or cpp.
  • The name of the object type in the domain, e.g., function.