wagtail/docs
Edy b9cfc24b37 Fixed broken email header when hosting static files remotely (#5543)
Fixes #5525
2019-09-06 12:13:07 +01:00
..
_static Release note for StreamField design update (#5476) 2019-08-23 15:53:48 +01:00
advanced_topics Add setting to disable email management 2019-09-04 10:25:35 +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 Add note about CurrentSiteMiddleware incompatibility 2019-09-02 16:18:41 +01:00
reference update docs for TabbedInterface (#5374) 2019-08-29 11:23:13 +01:00
releases Fixed broken email header when hosting static files remotely (#5543) 2019-09-06 12:13:07 +01:00
topics Upgrade minimum 6.x release for Elasticsearch to 6.4.0 2019-08-18 15:37:11 +10:00
Makefile add way of autocompile documentation 2017-02-20 20:24:17 +00:00
README.md
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
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

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.