wagtail/docs
Robert Rollins ef4b37cf5d Changed Snippet Chooser AJAX delay from 50ms to 200ms, to remove laggy typing. (#5439)
50ms is the equivalent of about 200 words per minute, so typing slower than that
meant that the javascript would send an AJAX request between every single
keystroke. This change makes the javascript wait for 200ms between keystrokes,
which lets you finish typing the word you're looking for before it sends an AJAX
request.
2019-08-29 14:13:23 +01:00
..
_static Release note for StreamField design update (#5476) 2019-08-23 15:53:48 +01:00
advanced_topics fix(docs/customization): Add models import to fix example (#5520) 2019-08-20 11:57:14 +01:00
contributing Clarify CHANGELOG instructions in "Committing code" docs (#5483) 2019-08-05 13:35:29 +01:00
editor_manual Add support for phone links in rich text 2019-08-01 16:12:22 +02:00
getting_started Remove support for Python 3.4 2019-04-10 17:39:53 +01:00
reference update docs for TabbedInterface (#5374) 2019-08-29 11:23:13 +01:00
releases Changed Snippet Chooser AJAX delay from 50ms to 200ms, to remove laggy typing. (#5439) 2019-08-29 14:13:23 +01:00
topics Upgrade minimum 6.x release for Elasticsearch to 6.4.0 2019-08-18 15:37:11 +10:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py Add Wagtail Space Arnhem banner to documentation 2019-01-24 11:28:56 +00: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
Makefile add way of autocompile documentation 2017-02-20 20:24:17 +00:00
README.md Eliminate reference to requirements-dev.txt 2016-02-05 15:48:01 +00: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 note about not asking support questions in multiple places 2018-07-11 11:09:45 +01:00

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.