From 5c1c9a6e2fe82ffc1f55cd79d3872dfeadd3cc7a Mon Sep 17 00:00:00 2001 From: Matt Westcott Date: Tue, 15 May 2018 14:57:07 +0100 Subject: [PATCH] Move HelpPanel documentation to avoid redefinition of wagtail.admin.edit_handlers module --- docs/reference/pages/panels.rst | 45 +++++++++++++++------------------ 1 file changed, 21 insertions(+), 24 deletions(-) diff --git a/docs/reference/pages/panels.rst b/docs/reference/pages/panels.rst index a9891b86a..453d50784 100644 --- a/docs/reference/pages/panels.rst +++ b/docs/reference/pages/panels.rst @@ -91,6 +91,27 @@ FieldRowPanel A class to apply to the FieldRowPanel as a whole +HelpPanel +--------- + +.. class:: HelpPanel(content='', template='wagtailadmin/edit_handlers/help_panel.html', heading='', classname='') + + .. attribute:: HelpPanel.content + + HTML string that gets displayed in the panel. + + .. attribute:: HelpPanel.template + + Path to a template rendering the full panel HTML. + + .. attribute:: HelpPanel.heading + + A heading for the help content. + + .. attribute:: HelpPanel.classname + + String of CSS classes given to the panel which are used in formatting and scripted interactivity. + PageChooserPanel ---------------- @@ -239,30 +260,6 @@ SnippetChooserPanel See :ref:`snippets` for more information. -HelpPanel ---------- - -.. module:: wagtail.admin.edit_handlers - -.. class:: HelpPanel(content='', template='wagtailadmin/edit_handlers/help_panel.html', heading='', classname='') - - .. attribute:: HelpPanel.content - - HTML string that gets displayed in the panel. - - .. attribute:: HelpPanel.template - - Path to a template rendering the full panel HTML. - - .. attribute:: HelpPanel.heading - - A heading for the help content. - - .. attribute:: HelpPanel.classname - - String of CSS classes given to the panel which are used in formatting and scripted interactivity. - - Built-in Fields and Choosers ~~~~~~~~~~~~~~~~~~~~~~~~~~~~