wagtail/docs
Janneke Janssen 3536796471 Correct dropdown arrow styling in Firefox, IE11. Fix #4336 (#4373) 2018-03-15 12:36:51 +01:00
..
_static
advanced_topics Typo and clarification (#4319) 2018-02-27 22:08:57 +02:00
contributing
editor_manual
getting_started
reference
releases Correct dropdown arrow styling in Firefox, IE11. Fix #4336 (#4373) 2018-03-15 12:36:51 +01:00
topics
Makefile
README.md
autobuild.sh
conf.py add favicon to documentation 2018-03-08 12:24:13 +00:00
favicon.ico add favicon to documentation 2018-03-08 12:24:13 +00:00
index.rst
logo.png
readthedocs.yml
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.