wagtail/docs
Sergey Fedoseev 5f7b7230a2 Fix SERVER_PORT for Page.dummy_request() when page is attached to Site with 443 port. (#4950) 2018-12-11 12:39:20 +00:00
..
_static Update welcome page screenshot (ref #4892) 2018-11-13 11:39:12 +00:00
advanced_topics Documentation on rich text internals (#4927) 2018-11-29 16:36:09 +00:00
contributing First positional argument for tox as test module/case path 2018-10-30 12:16:45 +00:00
editor_manual
getting_started Use intersphinx for Django references when possible. (#4896) 2018-11-14 11:48:32 +00:00
reference Use better examples in ModelAdmin docs, add info about FieldPanels 2018-11-30 13:11:53 +00:00
releases Fix SERVER_PORT for Page.dummy_request() when page is attached to Site with 443 port. (#4950) 2018-12-11 12:39:20 +00:00
topics Remove old versionchanged note 2018-12-07 11:59:55 +00:00
Makefile
README.md
autobuild.sh
conf.py Fix reference in ModelAdmin.ordering docs. 2018-10-30 12:23:17 +00:00
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.