wagtail/docs
Tim Heap 6bd168580e Change Indexed.search_fields to be a listish thing
Indexed.search_fields used to be a tuple. This is incorrect, and it
should have been a list.  Changing it to be a list now would be a
backwards incompatible change, as people do

    search_fields = Page.search_fields + (
        SearchField('body')
    )

Adding a tuple to the end of a list causes an error, so this would
cause all old code that used tuples to throw an error. This is not
great.

A new ThisShouldBeAList class, which subclasses list, has been added.
It additionally allows tuples to be added to it, as in the above
behaviour, but will raise a deprecation warning if someone does this.
Old code that uses tuples will continue to work, but raise a deprecation
warning.

See #2310
2016-03-24 21:05:09 +00:00
..
_static/images Promote the redesigned userbar to a major feature 2016-03-08 15:48:24 +00:00
advanced_topics Various typo fixes and grammar/clarity improvements. 2016-03-10 15:11:41 +00:00
contributing Add docs on how to build docs 2016-03-11 17:24:38 +00:00
editor_manual Correcting typo int The Dashboard doc 2016-02-16 15:51:57 -05:00
getting_started Change Indexed.search_fields to be a listish thing 2016-03-24 21:05:09 +00:00
reference CamelCase JavaScript in hooks documentation 2016-03-11 17:19:45 +00:00
releases Changelog/release note for #2382 2016-03-24 20:58:31 +00:00
topics Change Indexed.search_fields to be a listish thing 2016-03-24 21:05:09 +00:00
Makefile
README.md
autobuild.sh
conf.py
index.rst
logo.png
requirements.txt
spelling_wordlist.txt
support.rst

README.md

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.