Hopiu/wagtail
1
0
Fork 0
mirror of https://github.com/Hopiu/wagtail.git synced 2026-05-21 13:31:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Move HelpPanel documentation to avoid redefinition of wagtail.admin.edit_handlers module

Browse source
This commit is contained in:
Matt Westcott 2018-05-15 14:57:07 +01:00
parent 5bd47f46d4
commit 5c1c9a6e2f
1 changed files with 21 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
docs/reference/pages/panels.rst
View file

@ -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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~