wagtail/docs
Lars van de Kerkhof 6194dcb74b Do not download entire search index on search terms with no hits
When a slice is specifically set to [0:0], which would yield an empty list,
instead wagtail will clear the slice, effectively downloading the entire search
index.

This scenario happens when a search term does not return any results.
So every time you enter a search term that has no results, the entire search
index is downloaded, you don't really feel it because wagtail only downloads
the pk values, and it is unlikely a site has millions of pages, but it is still
very inefficient and unwanted.
2020-05-15 11:45:54 +10:00
..
_static fix sphinx warnings (#6001) 2020-05-03 14:02:43 +02:00
advanced_topics improve Adding Reports documentation 2020-05-10 17:15:32 +10:00
contributing Upgrade to Gulp v4 & Node 10 2020-05-01 12:01:03 +10:00
editor_manual Add 'add_redirect' static method to Redirect 2020-05-10 18:48:33 +10:00
getting_started
reference Add Snippet hooks (after_edit_snippet, after_create_snippet and after_delete_snippet) 2020-05-14 20:47:36 +10:00
releases Do not download entire search index on search terms with no hits 2020-05-15 11:45:54 +10:00
topics Add ability to define form_classname on ListBlock & StreamBlock 2020-05-10 16:48:24 +10:00
Makefile
README.md
autobuild.sh
conf.py fix sphinx warnings (#6001) 2020-05-03 14:02:43 +02:00
favicon.ico
index.rst
logo.png
requirements.txt
spelling_wordlist.txt
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.