wagtail/docs
Karl Hobley 4deb1dbff0 Renamed wagtail.wagtailredirects to wagtail.contrib.redirects
Conflicts:
	docs/advanced_topics/settings.rst
	docs/getting_started/integrating_into_django.rst
	wagtail/contrib/redirects/forms.py
	wagtail/contrib/redirects/permissions.py
	wagtail/contrib/redirects/tests.py
	wagtail/contrib/redirects/views.py
	wagtail/contrib/redirects/wagtail_hooks.py
	wagtail/project_template/project_name/settings/base.py
	wagtail/tests/settings.py
2017-11-26 22:43:47 +00:00
..
_static/images Add 'The Zen of Wagtail' document 2017-09-27 12:20:34 +01:00
advanced_topics Renamed wagtail.wagtailredirects to wagtail.contrib.redirects 2017-11-26 22:43:47 +00:00
contributing Rename wagtail.wagtailcore to wagtail.core 2017-11-26 22:43:47 +00:00
editor_manual Update documentation referring to the explorer menu 2017-05-17 13:14:50 +01:00
getting_started Renamed wagtail.wagtailredirects to wagtail.contrib.redirects 2017-11-26 22:43:47 +00:00
reference Renamed wagtail.wagtailforms to wagtail.contrib.forms 2017-11-26 22:43:47 +00:00
releases Rename wagtail.wagtailcore to wagtail.core 2017-11-26 22:43:47 +00:00
topics Rename wagtail.wagtailsnippets to wagtail.snippets 2017-11-26 22:43:47 +00: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
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py Move version from wagtail.wagtailcore to wagtail 2016-08-18 12:05:33 +01:00
index.rst Moved advanced image topics into advanced topics 2016-01-27 11:27:16 +00:00
logo.png
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 Remove references to Gondor.io in documentation. 2017-01-30 12:36:26 +00:00
support.rst Mention Slack on support documentation 2017-11-15 21:06:45 +00: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.