champollion.directive.rst_generator

champollion.directive.rst_generator.get_rst_class_elements(environment, module_name, module_path_name, whitelist_names=None, undocumented_members=False, private_members=False, force_partial_import=False, skip_attribute_value=False, rst_elements=None)

Return reStructuredText from class elements within environment.

module_name is the module alias that should be added to each directive.

module_path_name is the module path alias that should be added to each directive.

whitelist_names is an optional list of element names that should be displayed exclusively.

undocumented_members indicate whether undocumented element should be displayed.

private_members indicate whether elements starting with an underscore should be displayed.

force_partial_import indicate whether the import statement should force the partial import display if necessary.

skip_attribute_value indicate whether attribute value within the class should not be displayed.

rst_elements can be an initial dictionary that will be updated and returned.

champollion.directive.rst_generator.get_rst_attribute_elements(class_environment, whitelist_names=None, blacklist_ids=None, undocumented_members=False, private_members=False, skip_value=False, rst_elements=None)

Return reStructuredText from class attribute elements within class_environment.

whitelist_names is an optional list of element names that should be displayed exclusively.

blacklist_ids is an optional list of element identifiers that should not be displayed.

undocumented_members indicate whether undocumented element should be displayed.

private_members indicate whether elements starting with an underscore should be displayed.

skip_value indicate whether the value should not be displayed.

rst_elements can be an initial dictionary that will be updated and returned.

champollion.directive.rst_generator.get_rst_method_elements(class_environment, whitelist_names=None, skip_constructor=False, undocumented_members=False, private_members=False, rst_elements=None)

Return reStructuredText from class method elements within class_environment.

whitelist_names is an optional list of element names that should be displayed exclusively.

skip_constructor indicate whether the class constructor should be displayed.

undocumented_members indicate whether undocumented element should be displayed.

private_members indicate whether elements starting with an underscore should be displayed.

rst_elements can be an initial dictionary that will be updated and returned.

champollion.directive.rst_generator.get_rst_function_elements(environment, module_name, module_path_name, whitelist_names=None, undocumented_members=False, private_members=False, force_partial_import=False, rst_elements=None)

Return reStructuredText from function elements within environment.

module_name is the module alias that should be added to each directive.

module_path_name is the module path alias that should be added to each directive.

whitelist_names is an optional list of element names that should be displayed exclusively.

undocumented_members indicate whether undocumented element should be displayed.

private_members indicate whether elements starting with an underscore should be displayed.

force_partial_import indicate whether the import statement should force the partial import display if necessary.

rst_elements can be an initial dictionary that will be updated and returned.

champollion.directive.rst_generator.get_rst_data_elements(environment, module_name, module_path_name, whitelist_names=None, blacklist_ids=None, undocumented_members=False, private_members=False, force_partial_import=False, skip_value=False, rst_elements=None)

Return reStructuredText from data elements within environment.

module_name is the module alias that should be added to each directive.

module_path_name is the module path alias that should be added to each directive.

whitelist_names is an optional list of element names that should be displayed exclusively.

blacklist_ids is an optional list of element identifiers that should not be displayed.

undocumented_members indicate whether undocumented element should be displayed.

private_members indicate whether elements starting with an underscore should be displayed.

force_partial_import indicate whether the import statement should force the partial import display if necessary.

skip_value indicate whether the value should not be displayed.

rst_elements can be an initial dictionary that will be updated and returned.

champollion.directive.rst_generator.get_rst_export_elements(file_environment, environment, module_name, module_path_name, skip_data_value=False, skip_attribute_value=False, rst_elements=None)

Return reStructuredText from exported elements within file_environment.

environment is the full Javascript environment processed in parser.

module_name is the module alias that should be added to each directive.

module_path_name is the module path alias that should be added to each directive.

skip_data_value indicate whether data value should not be displayed.

skip_attribute_value indicate whether attribute value should not be displayed.

rst_elements can be an initial dictionary that will be updated and returned.

champollion.directive.rst_generator.get_rst_default_from_file_environment(file_environment, alias, module_name, module_path_name, skip_data_value=False, skip_attribute_value=False)

Return reStructuredText from default element in file_environment.

alias is the name that should replace the element name.

module_name is the module alias that should replace the element module name.

module_path_name is the module path alias that should be added to each directive.

skip_data_value indicate whether data value should not be displayed.

skip_attribute_value indicate whether attribute value should not be displayed.

Warning

Return None if no default is found in the file.

champollion.directive.rst_generator.get_rst_name_from_file_environment(name, file_environment, alias, module_name, module_path_name, skip_data_value=False, skip_attribute_value=False)

Return reStructuredText element in file_environment from name.

alias is the name that should replace the element name.

module_name is the module name that should replace the element module name.

module_path_name is the module path alias that should be added to each directive.

skip_data_value indicate whether data value should not be displayed.

skip_attribute_value indicate whether attribute value should not be displayed.

Warning

Return None if the element is not found in the file.

champollion.directive.rst_generator.rst_generate(directive, element_id, alias=None, module_alias=None, module_path_alias=None, extra_options=None)

Generate StringList from directive and element_id.

directive is one of the directive added to the Javascript domain by this sphinx extension.

element_id is an element ID returned by the parser.

alias is the name that should replace the element name.

module_alias is the module name that should replace the element module name.

module_path_alias is the module path that should replace the element module path.

extra_options can be a list of extra options to add to the directive.

champollion.directive.rst_generator.rst_string(expression='')

Return StringList from expression.