class documentation
Undocumented
Method | clear |
Remove traces of a document in the domain-specific inventories. |
Method | merge |
Merge in data regarding *docnames* from a different domaindata inventory (coming from a subprocess in parallel builds). |
Method | process |
Process a document after it is read by the environment. |
Class Variable | label |
Undocumented |
Class Variable | name |
Undocumented |
Property | todos |
Undocumented |
Inherited from Domain
:
Method | __init__ |
Undocumented |
Method | add |
Add an object type. |
Method | check |
Do consistency checks (**experimental**). |
Method | directive |
Return a directive adapter class that always gives the registered directive its full name ('domain:name') as ``self.name``. |
Method | get |
Get type of enumerable nodes (experimental). |
Method | get |
Return full qualified name for given node. |
Method | get |
Return an iterable of "object descriptions". |
Method | get |
Return full name for given ObjType. |
Method | process |
Process a pending xref created in a doc field. For example, attach information about the current scope. |
Method | resolve |
Resolve the pending_xref *node* with the given *target*. |
Method | resolve |
Resolve the pending_xref *node* with the given *typ* and *target*. |
Method | role |
Return a role adapter function that always gives the registered role its full name ('domain:name') as the first argument. |
Method | setup |
Set up domain object. |
Class Variable | dangling |
Undocumented |
Class Variable | data |
Undocumented |
Class Variable | enumerable |
Undocumented |
Class Variable | initial |
Undocumented |
Instance Variable | data |
Undocumented |
Instance Variable | directives |
Undocumented |
Instance Variable | env |
Undocumented |
Instance Variable | indices |
Undocumented |
Instance Variable | object |
Undocumented |
Instance Variable | objtypes |
Undocumented |
Instance Variable | role |
Undocumented |
Instance Variable | roles |
Undocumented |
Instance Variable | _directive |
Undocumented |
Instance Variable | _role2type |
Undocumented |
Instance Variable | _role |
Undocumented |
Instance Variable | _type2role |
Undocumented |
overrides
sphinx.domains.Domain.clear_doc
Remove traces of a document in the domain-specific inventories.
Parameters | |
docname:str | Undocumented |
overrides
sphinx.domains.Domain.process_doc
Process a document after it is read by the environment.
Parameters | |
env:BuildEnvironment | Undocumented |
docname:str | Undocumented |
document:nodes.document | Undocumented |