0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 09:33:54 +01:00
wagtail/docs
Kees Hink a2b9c2bfe4 Document pep8 issues to ignore (#3503)
* Docs: E501 is not the only PEP8 violation we accept.

* Add the list of PEP8 violations we accept to tox.ini
2017-03-25 15:10:12 +01:00
..
_static/images
advanced_topics Allow spaces in tag fields 2017-03-23 17:19:47 +01:00
contributing Document pep8 issues to ignore (#3503) 2017-03-25 15:10:12 +01:00
editor_manual Restrict view_draft to can_publish / can_edit permissions (#3474) 2017-03-24 11:54:10 +01:00
getting_started
reference Removed docs 2017-03-23 12:30:21 +01:00
releases Fixes ticket #2251. Implemented is_multipart on EditHandler and created tests. 2017-03-25 13:20:24 +01:00
topics Restrict view_draft to can_publish / can_edit permissions (#3474) 2017-03-24 11:54:10 +01:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py
index.rst
logo.png
Makefile add way of autocompile documentation 2017-02-20 20:24:17 +00:00
README.md
requirements.txt
spelling_wordlist.txt
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 -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.