Theme API reference

This page gives an overview of all public govuk_tech_docs_sphinx_theme objects, functions and methods. All classes and functions exposed in govuk_tech_docs_sphinx_theme.* namespace are public.

Theme build

add_js_files(app, files)

Add a list of JavaScript files to the script_files configuration variable of the theme.

setup(app)

Set up function for the Sphinx theme.

GOV.UK Design System components

NotificationBanner(name, arguments, options, …)

Create a notification banner based on the GOV.UK Design System.

WarningText(name, arguments, options, …)

Create warning text based on the GOV.UK Design System.