sphinx.domains.javascript.JSModule

class documentation

class JSModule(SphinxDirective):

Directive to mark description of a new JavaScript module.

This directive specifies the module name that will be used by objects that follow this directive.

Options

noindex: If the noindex option is specified, no linkable elements will be created, and the module won't be added to the global module index. This is useful for splitting up the module definition across multiple sections or files.

Parameters
mod_name	Module name

Method	`make_old_id`	Generate old styled node_id for JS modules.
Method	`run`	Undocumented
Class Variable	`final_argument_whitespace`	Undocumented
Class Variable	`has_content`	Undocumented
Class Variable	`option_spec`	Undocumented
Class Variable	`optional_arguments`	Undocumented
Class Variable	`required_arguments`	Undocumented

Inherited from SphinxDirective:

Method	`get_location`	Get current location info for logging.
Method	`get_source_info`	Get source and line number.
Method	`set_source_info`	Set source and line number to the node.
Property	`config`	Reference to the `.Config` object.
Property	`env`	Reference to the `.BuildEnvironment` object.

def make_old_id(self, modname):

Generate old styled node_id for JS modules.

Note

Old Styled node_id was used until Sphinx-3.0. This will be removed in Sphinx-5.0.

def run(self):

Undocumented

Returns
`List[Node]`	Undocumented

final_argument_whitespace: bool =

Undocumented

has_content: bool =

Undocumented

option_spec: OptionSpec =

Undocumented

optional_arguments: int =

Undocumented

required_arguments: int =

Undocumented