wagtail/docs
jordan_bauer 0dac8f0764 added construction_hook_name to settings_menu (#5384) 2019-06-25 12:04:53 +01:00
..
_static Adds Collections section to editor's guide 2019-06-17 10:13:49 +01:00
advanced_topics Remove buggy tab order customisations in CMS admin (#5383, #5351) 2019-06-18 12:49:16 +01:00
contributing Remove bad practice example from CSS guidelines 2019-06-06 17:04:23 +01:00
editor_manual Adds Collections section to editor's guide 2019-06-17 10:13:49 +01:00
getting_started
reference added construction_hook_name to settings_menu (#5384) 2019-06-25 12:04:53 +01:00
releases added construction_hook_name to settings_menu (#5384) 2019-06-25 12:04:53 +01:00
topics
Makefile
README.md
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
requirements.txt
spelling_wordlist.txt
support.rst

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.