sphinx.domains.javascript.JavaScriptDomain

class documentation

class JavaScriptDomain(Domain): (source)

View In Hierarchy

JavaScript language domain.

Method clear_doc Remove traces of a document in the domain-specific inventories.
Method find_obj Undocumented
Method get_full_qualified_name Return full qualified name for given node.
Method get_objects Return an iterable of "object descriptions".
Method merge_domaindata Merge in data regarding *docnames* from a different domaindata inventory (coming from a subprocess in parallel builds).
Method note_module Undocumented
Method note_object Undocumented
Method resolve_any_xref Resolve the pending_xref *node* with the given *target*.
Method resolve_xref Resolve the pending_xref *node* with the given *typ* and *target*.
Class Variable directives Undocumented
Class Variable initial_data Undocumented
Class Variable label Undocumented
Class Variable name Undocumented
Class Variable object_types Undocumented
Class Variable roles Undocumented
Property modules Undocumented
Property objects Undocumented

Inherited from Domain:

Method __init__ Undocumented
Method add_object_type Add an object type.
Method check_consistency 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_enumerable_node_type Get type of enumerable nodes (experimental).
Method get_type_name Return full name for given ObjType.
Method process_doc Process a document after it is read by the environment.
Method process_field_xref Process a pending xref created in a doc field. For example, attach information about the current scope.
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_warnings Undocumented
Class Variable data_version Undocumented
Class Variable enumerable_nodes Undocumented
Instance Variable data Undocumented
Instance Variable env Undocumented
Instance Variable indices Undocumented
Instance Variable objtypes_for_role Undocumented
Instance Variable role_for_objtype Undocumented
Instance Variable _directive_cache Undocumented
Instance Variable _role2type Undocumented
Instance Variable _role_cache Undocumented
Instance Variable _type2role Undocumented
def clear_doc(self, docname): (source)
overrides sphinx.domains.Domain.clear_doc

Remove traces of a document in the domain-specific inventories.

Parameters
docname:strUndocumented
def find_obj(self, env, mod_name, prefix, name, typ, searchorder=0): (source)

Undocumented

Parameters
env:BuildEnvironmentUndocumented
mod_name:strUndocumented
prefix:strUndocumented
name:strUndocumented
typ:str|NoneUndocumented
searchorder:intUndocumented
Returns
tuple[str|None, tuple[str, str, str]|None]Undocumented
def get_full_qualified_name(self, node): (source)
overrides sphinx.domains.Domain.get_full_qualified_name

Return full qualified name for given node.

Parameters
node:ElementUndocumented
Returns
str|NoneUndocumented
def get_objects(self): (source)
overrides sphinx.domains.Domain.get_objects

Return an iterable of "object descriptions". Object descriptions are tuples with six items: ``name`` Fully qualified name. ``dispname`` Name to display when searching/linking. ``type`` Object type, a key in ``self.object_types``. ``docname`` The document where it is to be found. ``anchor`` The anchor name for the object. ``priority`` How "important" the object is (determines placement in search results). One of: ``1`` Default priority (placed before full-text matches). ``0`` Object is important (placed before default-priority objects). ``2`` Object is unimportant (placed after full-text matches). ``-1`` Object should not show up in search at all.

Returns
Iterator[tuple[str, str, str, str, str, int]]Undocumented
def merge_domaindata(self, docnames, otherdata): (source)
overrides sphinx.domains.Domain.merge_domaindata

Merge in data regarding *docnames* from a different domaindata inventory (coming from a subprocess in parallel builds).

Parameters
docnames:list[str]Undocumented
otherdata:dict[str, Any]Undocumented
def note_module(self, modname, node_id): (source)

Undocumented

Parameters
modname:strUndocumented
node_id:strUndocumented
def note_object(self, fullname, objtype, node_id, location=None): (source)

Undocumented

Parameters
fullname:strUndocumented
objtype:strUndocumented
node_id:strUndocumented
location:AnyUndocumented
def resolve_any_xref(self, env, fromdocname, builder, target, node, contnode): (source)
overrides sphinx.domains.Domain.resolve_any_xref

Resolve the pending_xref *node* with the given *target*. The reference comes from an "any" or similar role, which means that we don't know the type. Otherwise, the arguments are the same as for :meth:`resolve_xref`. The method must return a list (potentially empty) of tuples ``('domain:role', newnode)``, where ``'domain:role'`` is the name of a role that could have created the same reference, e.g. ``'py:func'``. ``newnode`` is what :meth:`resolve_xref` would return. .. versionadded:: 1.3

Parameters
env:BuildEnvironmentUndocumented
fromdocname:strUndocumented
builder:BuilderUndocumented
target:strUndocumented
node:pending_xrefUndocumented
contnode:ElementUndocumented
Returns
list[tuple[str, Element]]Undocumented
def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode): (source)
overrides sphinx.domains.Domain.resolve_xref

Resolve the pending_xref *node* with the given *typ* and *target*. This method should return a new node, to replace the xref node, containing the *contnode* which is the markup content of the cross-reference. If no resolution can be found, None can be returned; the xref node will then given to the :event:`missing-reference` event, and if that yields no resolution, replaced by *contnode*. The method can also raise :exc:`sphinx.environment.NoUri` to suppress the :event:`missing-reference` event being emitted.

Parameters
env:BuildEnvironmentUndocumented
fromdocname:strUndocumented
builder:BuilderUndocumented
typ:strUndocumented
target:strUndocumented
node:pending_xrefUndocumented
contnode:ElementUndocumented
Returns
Element|NoneUndocumented
directives = (source)
overrides sphinx.domains.Domain.directives

Undocumented

initial_data: dict[str, dict[str, tuple[str, str]]] = (source)
overrides sphinx.domains.Domain.initial_data

Undocumented

label: str = (source)
overrides sphinx.domains.Domain.label

Undocumented

name: str = (source)
overrides sphinx.domains.Domain.name

Undocumented

object_types = (source)
overrides sphinx.domains.Domain.object_types

Undocumented

roles = (source)
overrides sphinx.domains.Domain.roles

Undocumented

@property
modules: dict[str, tuple[str, str]] = (source)

Undocumented

@property
objects: dict[str, tuple[str, str, str]] = (source)

Undocumented