0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 09:33:54 +01:00
wagtail/docs
Bertrand Bordage d36fe2b253 Merge pull request #3462 from kaedroho/feature/images-in-api-simple
Allow custom field classes to be used in api_fields
2017-04-06 19:41:29 +02:00
..
_static/images Add image for m2m feature in release notes 2017-02-06 12:07:32 +00:00
advanced_topics Merge pull request #3462 from kaedroho/feature/images-in-api-simple 2017-04-06 19:41:29 +02:00
contributing Document pep8 issues to ignore (#3503) 2017-03-25 15:10:12 +01:00
editor_manual Added remove focalpoint button 2017-03-26 13:27:35 +02:00
getting_started Release note for #3305 2017-02-03 21:24:57 +00:00
reference Improved code separation in contrib.modeladmin (#3467) 2017-03-28 10:34:03 +01:00
releases Adds support for custom date and datetime formats (#2595) 2017-03-31 16:30:27 +01:00
topics Document that 'format' on Date(Time)Block must be one of the recognised DATE(TIME)_INPUT_FORMATS 2017-03-31 16:46:00 +01:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +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
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
requirements.txt update modelcluster/taggit in doc dependencies 2017-04-05 22:08:38 +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.