wagtail/docs
Matt Westcott 4fc05fc79e
Tutorial should refer to 'Pages', not 'Explorer' ()
2018-02-16 10:31:12 +00:00
..
_static Makes font in the documentation darker () 2018-02-12 18:25:05 +00:00
advanced_topics Add rich_text form data helper 2018-02-15 11:54:34 +00:00
contributing Add IE11 opt-out of rich text pasting, and documentation notes 2018-01-17 22:16:35 +02:00
editor_manual Wording fix () 2018-02-13 23:01:03 +00:00
getting_started Tutorial should refer to 'Pages', not 'Explorer' () 2018-02-16 10:31:12 +00:00
reference Fix modeladmin documentation typo () 2018-02-08 10:53:36 +00:00
releases Add release notes for form data helpers 2018-02-15 11:54:36 +00:00
topics Used Python 3 super() syntax also in documentation. () 2018-02-07 10:11:27 +00:00
Makefile
README.md
autobuild.sh
conf.py add wagtail colours to docs sidebar 2018-01-05 14:51:05 +10: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.