0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
Chris Rogers f28d37675e Merge pull request #1440 from chrxr/master
Updating editors manual docs for Wagtail 1.0.
2015-06-26 12:12:31 +01:00
..
_static/images Added snippets section 2015-06-25 12:00:46 +01:00
advanced_topics Moved page privacy to advanced topics 2015-06-02 09:14:55 +01:00
contributing Merge remote-tracking branch 'takeflight/refactor/remove-libsass' 2015-05-19 17:25:52 +01:00
editor_manual Added snippets section 2015-06-25 12:00:46 +01:00
getting_started Add basic blog template to tutorial. 2015-06-21 18:39:47 -04:00
reference Merge pull request #1422 from kaedroho/routablepage-docs-improvements 2015-06-24 09:52:29 +01:00
releases release note for #1212 2015-06-25 12:19:22 +01:00
topics Change heading styles 2015-06-22 10:29:36 +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 Add the Wagtail tutorial to docs 2015-06-01 15:30:07 +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 minor docs readme change 2015-06-23 14:54:35 +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

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 -r 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.