0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
2020-01-08 15:05:59 +00:00
..
_static Admin documents listing - rename 'uploaded' to 'created 2019-10-24 07:40:59 +10:00
advanced_topics Update links in docs to point at stable Django version 2019-12-01 13:19:40 +10:00
contributing Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
editor_manual Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
getting_started Make Django 3.0 support official 2019-12-17 14:24:31 +00:00
reference Merge branch 'author-specific-locking' of https://github.com/jacobtoppm/wagtail into kaedroho-author-specific-locking 2020-01-08 15:05:59 +00:00
releases Merge branch 'author-specific-locking' of https://github.com/kaedroho/wagtail into kaedroho-author-specific-locking 2020-01-08 15:02:19 +00:00
topics Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
Makefile Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
README.md Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
requirements.txt
spelling_wordlist.txt
support.rst Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00

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.