0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
2017-10-25 16:15:02 +01:00
..
_static/images
advanced_topics Remove more Django 1.8 references from docs 2017-10-25 16:15:02 +01:00
contributing Eliminate references to wagtaildemo from the docs 2017-10-11 16:58:30 +01:00
editor_manual
getting_started Remove more Django 1.8 references from docs 2017-10-25 16:15:02 +01:00
reference Remove note about Django 1.10 being required for postgres search backend 2017-10-25 16:15:02 +01:00
releases Changelog/release note for #3521 2017-10-25 15:28:32 +01:00
topics Update slugurl documentation with a "real-world" example. 2017-10-23 12:40:07 +01:00
autobuild.sh
conf.py
index.rst
logo.png
Makefile
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

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.