champollion.viewcode

class champollion.viewcode.ViewCode

Helper class to display the code for each Javascript module found and link it to the documentation.

js_modules = None

Store the modules elements to link to the code

classmethod add_source_code_links(app, doctree)

Parse doctree and add source code link when available.

Create temporary ‘js_modules’ in app builder environment to store all module information which will be used to create the code page links.

This function is called with the doctree-read Sphinx event, emitted when a doctree has been parsed and read by the environment, and is about to be pickled

classmethod create_code_pages(app)

Create all code pages and the links to the documentation.

This function is called with the html-collect-pages Sphinx event, emitted when the HTML builder is starting to write non-document pages.

classmethod create_code_page_index(app)

Create page index regrouping all code page links.

classmethod create_missing_code_link(app, env, node, content_node)

Resolve all ‘[source]’ links in Api documentation pages.

This function is called with the missing-reference Sphinx event, emitted when a cross-reference to a Python module or object cannot be resolved.