wagtail/docs
Karl Hobley edfd17a1f1 Reduce usage of edit handlers for workflow management (#6172)
* Use plain old Django forms for tasks

* Revert "Add ExcludeFieldsOnEditMixin for edit handlers, disabling specific fields when bound to an existing instance rather than creating a new one"

This reverts commit 62961b74bb.

* Move Workflow edit handler creation into Workflow forms

Only advantage of having it the way it was before is that allows
overriding the edit handler in subclasses. But nobody will be doing this
with workflows.

I've added a note into the code pointing out that we might want to
rethink using edit handlers if:

 - It gets easier to style formsets without using InlinePanel
 - We want to allow customisation of the form (the use of edit handlers
   should be considered an internal implementation detail at the moment)

* Make task name readonly but groups editable

* Update wagtail/admin/templates/wagtailadmin/workflows/task_chooser/includes/create_form.html

Co-authored-by: Dan Braghis <dan@zerolab.org>

* Update wagtail/admin/forms/workflows.py

Co-authored-by: Dan Braghis <dan@zerolab.org>

Co-authored-by: Dan Braghis <dan@zerolab.org>
2020-07-24 16:59:33 +01:00
..
_static Update images in documentation 2020-07-24 16:59:33 +01:00
advanced_topics Reduce usage of edit handlers for workflow management (#6172) 2020-07-24 16:59:33 +01:00
contributing Add section to explain commit to pull request 2020-05-19 17:56:26 +01:00
editor_manual Fix dashboard docs 2020-07-24 16:59:33 +01:00
getting_started Replace a few instances of re_path with path 2020-07-06 13:15:39 +01:00
reference Add new page methods and updated workflow state methods 2020-07-24 16:59:33 +01:00
releases Move workflow upgrade considerations to 2.10 2020-07-24 16:59:33 +01:00
topics Update info on publish permissions to match new workflow system 2020-07-24 16:59:33 +01:00
Makefile Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
README.md Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py fix sphinx warnings (#6001) 2020-05-03 14:02:43 +02:00
favicon.ico add favicon to documentation 2018-03-08 12:24:13 +00:00
index.rst Fix broken link to bakerydemo (#4834) 2018-10-21 11:38:28 +02:00
logo.png reduced size of logo 2015-07-07 14:41:41 +01:00
requirements.txt readthedocs needs a requirements.txt, apparently 2017-10-09 19:45:07 +01:00
spelling_wordlist.txt Added more words to the spelling wordlist 2018-04-05 12:13:05 +01:00
support.rst Add documentation for reporting security issues 2020-04-20 11:57:26 +10:00

README.md

Wagtail docs

These are Sphinx docs, automatically built at https://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.