0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
2018-11-13 11:39:12 +00:00
..
_static Update welcome page screenshot (ref #4892) 2018-11-13 11:39:12 +00:00
advanced_topics Add template tag for dynamic image url 2018-10-28 16:21:46 +03:00
contributing First positional argument for tox as test module/case path 2018-10-30 12:16:45 +00:00
editor_manual Update editor guide for embeds and documents in rich text, fix #4558 (#4632) 2018-07-09 10:07:03 +03:00
getting_started Update welcome page screenshot (ref #4892) 2018-11-13 11:39:12 +00:00
reference Fixed some formatting in 'Customising IndexView' doc. (#4877) 2018-10-30 12:29:11 +00:00
releases Revamp the image editing page (#4087) 2018-11-08 23:56:54 -05:00
topics Specify Elasticsearch <6.3.1 2018-08-10 14:27:07 +01:00
autobuild.sh
conf.py Fix reference in ModelAdmin.ordering docs. 2018-10-30 12:23:17 +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
Makefile add way of autocompile documentation 2017-02-20 20:24:17 +00:00
README.md
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.