mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00

History

Karl Hobley 92a433832f Merge remote-tracking branch 'torchbox/master' into image-smartcropping Conflicts: wagtail/wagtailimages/tests.py		2014-07-24 14:33:50 +01:00
..
_static/css	added editors guide docs	2014-03-25 14:14:18 +00:00
building_your_site	Removed old docs	2014-07-22 16:31:48 +01:00
editor_manual	fix documentation syntax errors / warnings	2014-07-04 21:57:58 +01:00
images	Added wagtail and django settings doc	2014-06-08 16:59:46 -04:00
releases	Changelog/release notes for multiple image uploader	2014-07-24 12:33:47 +01:00
search	Lots of small tweaks to docs	2014-07-15 14:16:46 +01:00
advanced_topics.rst	Merged with docs coming from torchbox	2014-05-22 19:25:30 -04:00
autobuild.sh	Roadmap update and auto doc builder	2014-03-11 17:39:13 +00:00
conf.py	Use SQLite3 database backend when building docs	2014-07-15 13:05:24 +01:00
contributing.rst	Text amendments.	2014-07-08 13:21:44 +01:00
deploying.rst	First pass at Sphinx docs	2014-02-18 17:45:31 +00:00
editing_api.rst	update docs to use decorator syntax for hooks	2014-07-14 18:25:14 +01:00
form_builder.rst	Added wagtail and django settings doc	2014-06-08 16:59:46 -04:00
frontend_cache_purging.rst	Lots of small tweaks to docs	2014-07-15 14:16:46 +01:00
gettingstarted.rst	fix documentation syntax errors / warnings	2014-07-04 21:57:58 +01:00
image_feature_detection.rst	Renamed feature detection setting to 'WAGTAILIMAGES_FEATURE_DETECTION_ENABLED'	2014-07-23 11:28:41 +01:00
index.rst	Retitled routable_page doc, added to index	2014-07-15 13:48:05 +01:00
Makefile	First pass at Sphinx docs	2014-02-18 17:45:31 +00:00
management_commands.rst	Added links to docs from 0.4 release notes	2014-07-08 14:43:49 +01:00
model_recipes.rst	more explicit instructions for migrating away from deprecated things	2014-07-10 15:47:14 +01:00
performance.rst	Lots of small tweaks to docs	2014-07-15 14:16:46 +01:00
private_pages.rst	Lots of small tweaks to docs	2014-07-15 14:16:46 +01:00
README.md	auto doc builder notes	2014-03-11 17:39:13 +00:00
requirements.txt	Added requirements file for docs	2014-07-15 12:39:42 +01:00
roadmap.rst	Add form builder documentation	2014-05-22 15:11:30 +01:00
routable_page.rst	Added routable page to release notes and changelog	2014-07-21 16:03:28 +01:00
settings.rst	Merge branch 'master' into feature/fep2	2014-07-04 22:00:46 +01:00
sitemap_generation.rst	Lots of small tweaks to docs	2014-07-15 14:16:46 +01:00
snippets.rst	rewrite documentation on binding pages to snippets (the linking model should be an inline child of the page, not a snippet itself)	2014-07-17 16:32:17 +01:00
static_site_generation.rst	Update example in static_site_generation docs to use new-style route API	2014-07-04 18:24:01 +01:00
support.rst	Include Twitter account in support contacts.	2014-02-18 23:03:42 +00:00

README.md

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 Sphinx and the RTD theme:

pip install Sphinx
pip install sphinx-rtd-theme

Then make html from this directory, and open _build/html/index.html in your browser.

We've provided a watchdog script (based on @jacobian's snippet) to auto-build your local docs when you save them. Install watchdog:

pip install watchdog

Then run ./autobuild.sh before you start editing.

The online editor at http://rst.ninjs.org/ is a helpful tool for checking reStructuredText syntax.