0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
2015-05-29 17:00:09 +01:00
..
_static/images moved pages, images, snippets, form builder, search into reference. Updated requirements, removed conflicting theme css file, updated README 2015-05-14 11:20:50 +01:00
advanced_topics Renamed howto to advanced topics 2015-05-28 12:58:50 +01:00
contributing Merge remote-tracking branch 'takeflight/refactor/remove-libsass' 2015-05-19 17:25:52 +01:00
editor_manual Spelling fixes for editors guide 2015-05-18 10:20:08 +01:00
getting_started Renamed howto to advanced topics 2015-05-28 12:58:50 +01:00
reference Fix typos 2015-05-29 14:21:08 +01:00
releases Added a link to AUTO_UPDATE docs from release notes 2015-05-29 17:00:09 +01:00
topics Added a link to AUTO_UPDATE docs from release notes 2015-05-29 17:00:09 +01:00
autobuild.sh Roadmap update and auto doc builder 2014-03-11 17:39:13 +00:00
conf.py added logo 2015-05-18 09:11:11 +01:00
index.rst Renamed howto to advanced topics 2015-05-28 12:58:50 +01:00
logo.png added logo 2015-05-18 09:11:11 +01:00
Makefile Added spellcheker 2015-04-17 22:49:16 +01:00
README.md moved pages, images, snippets, form builder, search into reference. Updated requirements, removed conflicting theme css file, updated README 2015-05-14 11:20:50 +01:00
requirements.txt Update django-taggit in docs 2015-03-27 15:15:57 +00:00
spelling_wordlist.txt Spellchecked editing api docs 2015-05-18 10:44:07 +01:00
support.rst Include Twitter account in support contacts. 2014-02-18 23:03:42 +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 Wagatail's development requirements (in the root Wagtail directory):

pip install requirements-dev.txt

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.