0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 09:33:54 +01:00
wagtail/docs
2017-10-26 14:34:58 +01:00
..
_static/images Add 'The Zen of Wagtail' document 2017-09-27 12:20:34 +01:00
advanced_topics Move Usage info (Documents, Images) to sidebar 2017-10-26 14:34:58 +01:00
contributing Eliminate references to wagtaildemo from the docs 2017-10-11 16:58:30 +01:00
editor_manual Update documentation referring to the explorer menu 2017-05-17 13:14:50 +01:00
getting_started Remove more Django 1.8 references from docs 2017-10-25 16:15:02 +01:00
reference Remove wagtail.contrib.wagtailapi 2017-10-25 16:49:17 +01:00
releases Changelog/release notes for #3925, #3930 and #3974 2017-10-26 13:55:21 +01:00
topics Update slugurl documentation with a "real-world" example. 2017-10-23 12:40:07 +01: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
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
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 Point people to Stack Overflow for support queries in preference to the Google group (#3255) 2017-01-03 16:02:24 +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.