wagtail/docs
Karl Hobley 80ff06f988 Rename wagtail.wagtailusers to wagtail.users
Conflicts:
	wagtail/admin/tests/test_pages_views.py
	wagtail/admin/utils.py
	wagtail/admin/views/account.py
	wagtail/users/views/groups.py
	wagtail/users/views/users.py
	wagtail/users/wagtail_hooks.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 Rename wagtail.wagtailusers to wagtail.users 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
getting_started Rename wagtail.wagtailusers to wagtail.users 2017-11-26 22:43:47 +00:00
reference Rename wagtail.wagtailsnippets to wagtail.snippets 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
README.md
autobuild.sh
conf.py
index.rst
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
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.