mirror of
https://github.com/wagtail/wagtail.git
synced 2024-12-01 03:31:04 +01:00
| .. | ||
| _static | ||
| contrib_components | ||
| core_components | ||
| editor_manual | ||
| howto | ||
| reference | ||
| releases | ||
| autobuild.sh | ||
| conf.py | ||
| gettingstarted.rst | ||
| index.rst | ||
| Makefile | ||
| README.md | ||
| requirements.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 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.