Matt Westcott
122575d2ee
Release note for #5848
|
5 years ago | |
|---|---|---|
| .. | ||
| _static | 5 years ago | |
| advanced_topics | 5 years ago | |
| contributing | 5 years ago | |
| editor_manual | 5 years ago | |
| getting_started | 5 years ago | |
| reference | 5 years ago | |
| releases | 5 years ago | |
| topics | 5 years ago | |
| Makefile | 5 years ago | |
| README.md | 5 years ago | |
| autobuild.sh | 8 years ago | |
| conf.py | 6 years ago | |
| favicon.ico | 7 years ago | |
| index.rst | 6 years ago | |
| logo.png | 9 years ago | |
| requirements.txt | 7 years ago | |
| spelling_wordlist.txt | 7 years ago | |
| support.rst | 5 years ago | |
README.md
Wagtail docs
These are Sphinx docs, automatically built at https://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 -e .[testing,docs]
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.