0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-25 05:02:57 +01:00
wagtail/docs
2018-01-04 14:06:17 +01:00
..
_static/images Add filter example images 2017-12-14 12:35:52 +00:00
advanced_topics Allow overriding login form via `WAGTAILADMIN_USER_LOGIN_FORM` setting 2018-01-03 15:57:40 +00:00
contributing Add line break to makemigrations code snippet 2017-11-27 01:11:09 +00:00
editor_manual Renamed wagtail.contrib.wagtailsearchpromotions to 2017-11-26 22:43:47 +00:00
getting_started add on_delete argument to ParentalKey & ForeignKey 2017-12-15 10:33:09 +00:00
reference Add missing import to tagging docs (#4158) 2017-12-29 17:54:38 +01:00
releases Adds release notes for #4059. 2018-01-04 14:06:17 +01:00
topics Doc typos. 2018-01-03 11:29:23 +01:00
autobuild.sh
conf.py
index.rst
logo.png
Makefile add way of autocompile documentation 2017-02-20 20:24:17 +00:00
README.md
readthedocs.yml requirements_file not needed, but maybe pip_install is 2017-10-09 18:15:36 +01:00
requirements.txt readthedocs needs a requirements.txt, apparently 2017-10-09 19:45:07 +01:00
spelling_wordlist.txt
support.rst Mention Slack on support documentation 2017-11-15 21:06:45 +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 -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.