wagtail/docs
Tim Heap e8a9f9d8c9 Use correctly sorted StreamBlock children in both prepend and append menus
Previously blocks were only correctly sorted and grouped in the prepend
menu, while they appeared in definition order in the append menu.
2018-02-22 13:52:13 +00:00
..
_static Makes font in the documentation darker (#4224) 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 (#4280) 2018-02-13 23:01:03 +00:00
getting_started Tutorial should refer to 'Pages', not 'Explorer' (#4293) 2018-02-16 10:31:12 +00:00
reference Fix modeladmin documentation typo (#4251) 2018-02-08 10:53:36 +00:00
releases Use correctly sorted StreamBlock children in both prepend and append menus 2018-02-22 13:52:13 +00:00
topics Used Python 3 super() syntax also in documentation. (#4246) 2018-02-07 10:11:27 +00:00
Makefile add way of autocompile documentation 2017-02-20 20:24:17 +00:00
README.md Eliminate reference to requirements-dev.txt 2016-02-05 15:48:01 +00:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py add wagtail colours to docs sidebar 2018-01-05 14:51:05 +10:00
index.rst Moved advanced image topics into advanced topics 2016-01-27 11:27:16 +00:00
logo.png reduced size of logo 2015-07-07 14:41:41 +01:00
readthedocs.yml requirements_file not needed, but maybe pip_install is 2017-10-09 18:15:36 +01:00
requirements.txt readthedocs needs a requirements.txt, apparently 2017-10-09 19:45:07 +01:00
spelling_wordlist.txt Remove references to Gondor.io in documentation. 2017-01-30 12:36:26 +00:00
support.rst Mention Slack on support documentation 2017-11-15 21:06:45 +00:00

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.