jiveapi.sphinx_theme.builder module

class jiveapi.sphinx_theme.builder.JiveHtmlTranslator(builder, *args, **kwds)

Bases: sphinx.writers.html.HTMLTranslator

Subclass of sphinx’s built-in HTMLTranslator to fix some output nuances. Mainly, Jive overwrites “id” elements on everything, so named anchors need to use the deprecated name attribute. We also need to identify internal hrefs that link to index.html#something and strip the leading filename.

add_permalink_ref(node, title)

depart_title(node)

visit_reference(node)

class jiveapi.sphinx_theme.builder.JiveapiBuilder(app)

Bases: sphinx.builders.html.SingleFileHTMLBuilder

Subclass of sphinx’s built-in SingleFileHTMLBuilder to use JiveHtmlTranslator in place of sphinx’s built-in HTMLTranslator.

default_translator_class

epilog = 'The Jive HTML page is in %(outdir)s.'

name = 'jiveapi'

script_files = []

jiveapi.sphinx_theme.builder.setup(app)