0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
2017-02-03 21:24:56 +00:00
..
_static/images Add 'Categories' section to tutorial 2017-02-03 21:24:54 +00:00
advanced_topics Add Wagtail-Multilingual to third-party tutorials (#3317) 2017-02-03 09:52:00 +00:00
contributing Removing errant words in sample path/to/wagtail 2017-02-03 20:41:08 +00:00
editor_manual Fix whitespace errors in docs 2016-11-28 13:41:35 +00:00
getting_started Add 'Categories' section to tutorial 2017-02-03 21:24:54 +00:00
reference in Page reference docs, don't tell people to consult source code (#3303) 2017-01-28 00:11:52 +00:00
releases Upgrade note re new versions of django-modelcluster and django-taggit 2017-02-03 21:24:56 +00:00
topics Documentation and release notes for #3275 2017-01-16 18:51:42 +00:00
autobuild.sh Roadmap update and auto doc builder 2014-03-11 17:39:13 +00:00
conf.py Move version from wagtail.wagtailcore to wagtail 2016-08-18 12:05:33 +01: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
Makefile Added spellcheker 2015-04-17 22:49:16 +01:00
README.md Eliminate reference to requirements-dev.txt 2016-02-05 15:48:01 +00:00
requirements.txt Build documentation with Django 1.8 fixes #1451 2015-06-29 09:11:21 +01:00
spelling_wordlist.txt Remove references to Gondor.io in documentation. 2017-01-30 12:36:26 +00:00
support.rst Point people to Stack Overflow for support queries in preference to the Google group (#3255) 2017-01-03 16:02:24 +00:00

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.