Bertrand Bordage 0a50aaf130 Typo. 6 years ago
..
_static dd4fb080e0 rename docs image 6 years ago
advanced_topics 48b5740d03 Merge branch 'docs-divio-cloud' of https://github.com/evildmp/wagtail into evildmp-docs-divio-cloud 6 years ago
contributing c5357dd271 second attempt ro clarify issue #4620 6 years ago
editor_manual b5bfb66a11 Add note about deleting in docs 6 years ago
getting_started c38b172793 updated Django Docs Links to point to *docs.djangoproject.com/en/stable/* 6 years ago
reference 8d786c3534 Reference the `get_url` method in Page model reference docs 6 years ago
releases 806ba75497 Adds release notes for #4508. 6 years ago
topics 0a50aaf130 Typo. 6 years ago
Makefile f70226c845 add way of autocompile documentation 8 years ago
README.md 4bdc32aaad Eliminate reference to requirements-dev.txt 9 years ago
autobuild.sh c239932434 [skip ci] added commment about autobuild inside vms (#3379) 8 years ago
conf.py 06227a11ea Removes the temporary Kickstarter banner. 7 years ago
favicon.ico e2f2a8c005 add favicon to documentation 7 years ago
index.rst b1db6c5882 Added Divio Cloud notes to documentation 6 years ago
logo.png 82171f70fa reduced size of logo 9 years ago
readthedocs.yml a52d5be479 requirements_file not needed, but maybe pip_install is 7 years ago
requirements.txt f15a98f983 readthedocs needs a requirements.txt, apparently 7 years ago
spelling_wordlist.txt 9ab54d0811 Added more words to the spelling wordlist 7 years ago
support.rst 676a5edee3 Mention Slack on support documentation 7 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 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.