0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 03:31:04 +01:00
wagtail/docs
DanAtShenTech c9be245b0f Update primer.rst (#5062)
Small grammar fixes
2019-02-08 17:02:30 +00:00
..
_static
advanced_topics
contributing
editor_manual Removing confirmation of publishing from documentation (#5006) 2019-01-24 12:18:47 +00:00
getting_started Add MEDIA_* settings to Django integration page (#5046) 2019-01-31 12:19:42 +00:00
reference Update primer.rst (#5062) 2019-02-08 17:02:30 +00:00
releases Preserve links when copy-pasting rich text content from Wagtail to other tools (#5054) 2019-02-07 00:01:03 +02:00
topics Allow disabling search auto-update on a per-model basis (#4946) 2019-01-29 17:06:41 +00:00
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
Makefile
README.md
requirements.txt
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.