0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-30 01:46:24 +01:00
wagtail/docs
2018-04-19 12:37:52 +01:00
..
_static Removes the temporary Kickstarter banner. 2018-04-16 17:16:05 +02:00
advanced_topics Expose reusable client-side code to build Draftail extensions (#4467) 2018-04-18 00:27:07 +03:00
contributing
editor_manual
getting_started
reference Improved 'purge_page_from_cache' to purge the url for any managed language 2018-04-18 11:28:23 +01:00
releases Add extra_footer_actions template blocks 2018-04-19 12:37:52 +01:00
topics
autobuild.sh
conf.py Removes the temporary Kickstarter banner. 2018-04-16 17:16:05 +02:00
favicon.ico
index.rst
logo.png
Makefile
README.md
readthedocs.yml
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 -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.