champollion.directive.js_module¶
-
class
champollion.directive.js_module.
AutoModuleDirective
(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶ Directive to render Javascript module documentation.
The unique argument should be the identifier of the module element.
.. js:automodule:: module.test
The available options are:
- members:
- This option can be boolean if no arguments are given to indicate that all members should be documented, or a white list of member names to display.
- skip-description:
- Indicate whether the module description should be skipped.
- skip-data-value:
- Indicate whether data values within the module should be skipped.
- skip-attribute-value:
- Indicate whether attribute values within the module should be skipped.
- undoc-members:
- Indicate whether members with no docstrings should be displayed.
- private-members:
- Indicate whether private members (with a name starting with an underscore) should be displayed.
- module-alias:
- String element to replace the module name.
- module-path-alias:
- String element to replace the module path.
- force-partial-import:
- Indicate whether each import statement display within the module should be indicated with partial import.
See also
See also
-
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
-
option_spec
= {'force-partial-import': <function <lambda>>, 'members': <function _parse_members>, 'module-alias': <function unchanged_required>, 'module-path-alias': <function unchanged_required>, 'private-members': <function <lambda>>, 'skip-attribute-value': <function <lambda>>, 'skip-data-value': <function <lambda>>, 'skip-description': <function <lambda>>, 'undoc-members': <function <lambda>>}¶ module options
-
generate_members
(module_environment, options, whitelist_names=None)[source]¶ Generate a list of member nodes from module_environment
options is the dictionary of module options that can affect the display of members
whitelist_names is an optional list of element names that should be displayed exclusively.