edx_theme package

Module contents

A Sphinx theme for Open edX documentation.

edx_theme.feedback_form_url(project, page)

Create a URL for feedback on a particular page in a project.

edx_theme.get_html_theme_path()

Get the absolute path of the directory containing the theme files.

edx_theme.setup(app)

Sphinx extension to update the rendering context with the feedback form URL.

Arguments:
app (Sphinx): Application object for the Sphinx process
Returns:
a dictionary of metadata (http://www.sphinx-doc.org/en/stable/extdev/#extension-metadata)
edx_theme.update_context(app, pagename, templatename, context, doctree)

Update the page rendering context to include feedback_form_url.