0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-28 08:48:04 +01:00
wagtail/docs
Matt Westcott 9961455c6a Add formal support for customising the form rendering of StructBlocks
The `form_template` attribute was mentioned in passing in the docs, but was missing various things
to make it fully useful:

- context passed to form_template now includes 'prefix' and 'block_definition'
- context for the form is now populated in a separate overrideable `get_form_context` method
- full documentation and tests for form_template and get_form_context added
2016-07-05 11:48:09 +01:00
..
_static/images
advanced_topics Documented the settings variable for WAGTAIL_USAGE_COUNT_ENABLED (#2706) 2016-06-13 20:47:27 +01:00
contributing Document isort and 'make lint' in Python coding guidelines 2016-06-23 16:31:44 +01:00
editor_manual
getting_started
reference mention edit_handler in this context (#2716) 2016-06-15 13:54:54 +01:00
releases Add formal support for customising the form rendering of StructBlocks 2016-07-05 11:48:09 +01:00
topics Add formal support for customising the form rendering of StructBlocks 2016-07-05 11:48:09 +01:00
autobuild.sh
conf.py
index.rst
logo.png
Makefile
README.md
requirements.txt
spelling_wordlist.txt
support.rst

Wagtail docs

These are Sphinx docs, automatically built at http://docs.wagtail.io when the master 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.