champollion.directive.base

class champollion.directive.base.BaseDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Base class for Javascript object directive.

required_arguments = 1

Only the object id argument is required

optional_arguments = 0

No optional argument is available

has_content = False

Content is automatically generated and can not be manually entered

allow_nesting = False

Nested element is automatically generated and can not be manually entered

display_prefix = None

No prefix is displayed right before the documentation entry

run()

Run the directive.

generate_import_statement(environment, module_environment, force_partial_import=False)

Return import statement generated from environment and module_environment.

The import statement will be generated only if the element is exported and the usage of partial import will depend whether the element is exported as default.

force_partial_import indicate whether the usage of partial import should be used even if the element is exported as default.

Warning

The statement is using Javascript ES6 import keyword

Example:

import element from "module"
import {partialElement} from "module"

generate_description(environment)

Return description generated from environment.