onkyo_serial.doc module

Sphinx extensions used for onkyo_serial documentation.

onkyo_serial.doc.make_link_node(rawtext, app, link_text, slug, options)

Creates a link to a trac ticket.

Parameters:

• rawtext – text being replaced with link node
• app – sphinx application context
• link_text – text for the link
• slug – ID of the thing to link to
• options – options dictionary passed to role func

onkyo_serial.doc.role_twisted(name, rawtext, text, lineno, inliner, options=None, content=None)

Aliases twisted.internet to

‘https://twistedmatrix.com/documents/14.0.1/api/twisted.internet.html

Parameters:

• name – the role name used in the document
• rawtext – the entire markup snippet, with role
• text – the text marked with the role
• lineno – the line number where rawtext appears in the input
• inliner – the inliner instance that called us
• options – directive options for customization
• content – the directive content for customization

onkyo_serial.doc.setup(app)

Installs the plugin. :param app: sphinx application context