Dan Braghis
39ca18263a
Add the Wagtail tutorial to docs
|
9 years ago | |
|---|---|---|
| .. | ||
| _static | 9 years ago | |
| advanced_topics | 9 years ago | |
| contributing | 9 years ago | |
| editor_manual | 9 years ago | |
| getting_started | 9 years ago | |
| reference | 9 years ago | |
| releases | 9 years ago | |
| topics | 9 years ago | |
| Makefile | 10 years ago | |
| README.md | 10 years ago | |
| autobuild.sh | 11 years ago | |
| conf.py | 10 years ago | |
| index.rst | 9 years ago | |
| logo.png | 10 years ago | |
| requirements.txt | 10 years ago | |
| spelling_wordlist.txt | 10 years ago | |
| support.rst | 11 years ago | |
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 Wagatail's development requirements (in the root Wagtail directory):
pip install 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.