0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
2015-07-15 10:00:46 +01:00
..
_static/images added promoted search page 2015-07-07 11:31:12 +01:00
advanced_topics Merge branch 'search-config-tweak' of https://github.com/kaedroho/wagtail into kaedroho-search-config-tweak 2015-06-26 16:33:21 +01:00
contributing Merge remote-tracking branch 'takeflight/refactor/remove-libsass' 2015-05-19 17:25:52 +01:00
editor_manual added promoted search page 2015-07-07 11:31:12 +01:00
getting_started de-capitalise 'Body field' 2015-07-07 16:12:43 +01:00
reference Docs for descendant_of API filter 2015-07-15 09:57:53 +01:00
releases Changelog and release note for API descendant_of filter 2015-07-15 10:00:46 +01:00
topics Use search backend module imports in the docs 2015-07-01 14:36:50 +01:00
autobuild.sh Roadmap update and auto doc builder 2014-03-11 17:39:13 +00:00
conf.py added logo 2015-05-18 09:11:11 +01:00
index.rst Add the Wagtail tutorial to docs 2015-06-01 15:30:07 +01:00
logo.png reduced size of logo 2015-07-07 14:41:41 +01:00
Makefile Added spellcheker 2015-04-17 22:49:16 +01:00
README.md minor docs readme change 2015-06-23 14:54:35 +01:00
requirements.txt Build documentation with Django 1.8 fixes #1451 2015-06-29 09:11:21 +01:00
spelling_wordlist.txt Spellchecked editing api docs 2015-05-18 10:44:07 +01:00
support.rst Include Twitter account in support contacts. 2014-02-18 23:03:42 +00: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 -r requirements-dev.txt

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.