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

History

Tom Dyson 62d5e658d1 OS X installation instructions		2014-03-11 12:11:47 +00:00
..
building_your_site.rst	First pass at Sphinx docs	2014-02-18 17:45:31 +00:00
conf.py	More RTD-related Sphinx config changes	2014-02-18 18:05:50 +00:00
contributing.rst	Translations section for the docs.	2014-02-21 10:45:07 +00:00
deploying.rst	First pass at Sphinx docs	2014-02-18 17:45:31 +00:00
gettingstarted.rst	OS X installation instructions	2014-03-11 12:11:47 +00:00
index.rst	Roadmap page in docs	2014-03-11 11:20:26 +00:00
Makefile	First pass at Sphinx docs	2014-02-18 17:45:31 +00:00
performance.rst	Remove all reference to less/npm in docs and install scripts	2014-03-05 20:05:26 +00:00
README.md	Better docs docs	2014-03-11 11:01:04 +00:00
roadmap.rst	Roadmap page in docs	2014-03-11 11:20:26 +00:00
support.rst	Include Twitter account in support contacts.	2014-02-18 23:03:42 +00:00
wagtail_search.rst	First pass at Sphinx docs	2014-02-18 17:45:31 +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.

To auto-build your local docs when you save:

pip install watchdog
$ watchmedo shell-command \
          --patterns="*.rst" \
          --ignore-pattern='_build/*' \
          --recursive \
          --command='make html'

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