wagtail/docs
Sergey Fedoseev 057690815b Made HTTP_HOST of page dummy request include port. (#4954) 2019-01-17 12:34:04 +00:00
..
_static
advanced_topics Documentation on rich text internals (#4927) 2018-11-29 16:36:09 +00:00
contributing
editor_manual
getting_started
reference Add missing null=True and imports to modeladmin example code 2019-01-10 10:59:05 +00:00
releases Made HTTP_HOST of page dummy request include port. (#4954) 2019-01-17 12:34:04 +00:00
topics Remove old versionchanged note 2018-12-07 11:59:55 +00:00
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.