• Home
  • API Documentation
  • wte.doc – Docutils Helpers

wte.doc – Docutils Helpers¶

The doc module contains helper functions for the docutils ReST processing.

wte.doc.button_role(role, rawtext, text, node_id, inliner)[source]¶

Handles adding the necessary inline styling to indicate buttons in the documentation.

wte.doc.link_role(role, rawtext, text, node_id, inliner)[source]¶

Handles adding the necessary inline styling to indicate links in the documentation.

wte.doc.setup(app)[source]¶

Adds the new docutils roles to the docutils app

  • wte – Web Teaching Environment
  • wte.helpers – Helper functionality for views