0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
2018-02-12 16:55:01 +00:00
..
_static Add start of example for entity docs 2018-02-09 15:24:24 +00:00
advanced_topics Embed Docs: fix broken link (#4270) 2018-02-12 10:15:22 -05:00
contributing Add IE11 opt-out of rich text pasting, and documentation notes 2018-01-17 22:16:35 +02:00
editor_manual Rephrase confusing sentence in editor guide 2018-02-09 15:24:24 +00:00
getting_started Update wagtail url paths for Django 2.0 2018-02-12 16:55:01 +00:00
reference Fix modeladmin documentation typo (#4251) 2018-02-08 10:53:36 +00:00
releases Add wrapping for image titles in listing. Fix #4233 (#4243) 2018-02-10 01:56:30 +02:00
topics Used Python 3 super() syntax also in documentation. (#4246) 2018-02-07 10:11:27 +00:00
autobuild.sh
conf.py add wagtail colours to docs sidebar 2018-01-05 14:51:05 +10:00
index.rst
logo.png
Makefile add way of autocompile documentation 2017-02-20 20:24:17 +00:00
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 Mention Slack on support documentation 2017-11-15 21:06:45 +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.