wagtail/docs
Matt Westcott 82119360ac Ensure for_user is consistently passed to WagtailAdminModelForm (#9238)
Fixes #9230. When instantiating forms returned from `wagtail.admin.panels.get_form_for_model` (which are assumed to be WagtailAdminModelForm subclasses), always pass the for_user argument so that the form can incorporate custom logic that's dependent on the user object. Previously this was done for the main create/edit views, but not previews or revert.
2022-09-28 11:24:19 +01:00
..
_static Update editor manual screenshots 2022-09-12 21:57:43 +10:00
_templates use search input type for documentation search 2022-09-23 06:53:34 +10:00
advanced_topics Fix code style of example in Wagtail API docs 2022-09-19 21:49:01 +10:00
contributing Fix note markup in developing doc 2022-09-22 15:09:58 +10:00
editor_manual Revert chooser button labels to "Choose another X" 2022-09-14 07:40:38 +10:00
extending Add changelog entry for 4.0 - bulk actions for snippets #8574 2022-09-19 19:40:46 +10:00
getting_started Add alternative text for all documentation screenshots 2022-09-12 21:57:43 +10:00
public Add a security.txt file 2022-09-06 08:09:30 +10:00
reference Ensure all panels output their own help_text (#9240) 2022-09-28 10:49:08 +01:00
releases Ensure for_user is consistently passed to WagtailAdminModelForm (#9238) 2022-09-28 11:24:19 +01:00
topics Allow customising snippet listing columns with list_display 2022-09-28 10:39:48 +01:00
Makefile Fix broken "make livehtml" command 2021-02-04 11:55:02 -08:00
README.md auto-format core markdown files (#8603) 2022-06-01 23:08:56 +10:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py Add a security.txt file 2022-09-06 08:09:30 +10:00
favicon.ico add favicon to documentation 2018-03-08 12:24:13 +00:00
index.rst Update links to wagtail.io website to point to wagtail.org 2022-01-15 20:23:44 +10:00
logo.png
requirements.txt update Sphinx Wagtail Theme to 5.3.0 2022-08-24 06:07:47 +10:00
spelling_wordlist.txt Add more names and jargon to spelling wordlist 2020-10-03 14:43:03 +01:00
support.md documentation - migrate docs/support to markdown 2022-06-28 16:16:09 +10:00

README.md

Wagtail docs

These are Sphinx docs, automatically built at https://docs.wagtail.org when the main branch is committed to Github. To build them locally, install Wagtail's development requirements (in the root Wagtail directory):

pip install -e .[testing,docs]

To build the documentation for browsing, from this directory run:

make html

then open _build/html/index.html in a browser.

To rebuild automatically while editing the documentation, from this directory run:

sphinx-autobuild . _build

The online editor at http://rst.ninjs.org/ is a helpful tool for checking reStructuredText syntax.