mirror of
https://github.com/wagtail/wagtail.git
synced 2024-12-01 11:41:20 +01:00
377db9e878
* State the requirement for Node.js up-front (since it's required by everyone, not just front-end devs) * Point to vagrant-wagtail-develop instead of making people set up a Vagrant instance manually * No need to fiddle with python paths via local.py - 'setup.py develop' handles that * Skip instructions for virtualenvs (anyone who decides against the Vagrant route is expected to know how to use them) |
||
|---|---|---|
| .. | ||
| _static/images | ||
| advanced_topics | ||
| contributing | ||
| editor_manual | ||
| getting_started | ||
| reference | ||
| releases | ||
| topics | ||
| autobuild.sh | ||
| conf.py | ||
| index.rst | ||
| logo.png | ||
| Makefile | ||
| 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 -r requirements-dev.txt
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.