0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-30 01:46:24 +01:00
wagtail/docs
2020-06-25 10:31:29 +01:00
..
_static Tweak Wagtail logo hover animation in docs 2020-06-02 20:34:20 +10:00
advanced_topics Mention INSTALLED_APPS ordering in custom user docs 2020-05-18 11:33:53 +01:00
contributing Add section to explain commit to pull request 2020-05-19 17:56:26 +01:00
editor_manual Add 'add_redirect' static method to Redirect 2020-05-10 18:48:33 +10:00
getting_started Template render richtext without wrapper, add wagtail.contrib.legacy.richtext 2020-05-21 07:53:31 +10:00
reference Remove 'whitelist' from page reference docs (#6153) 2020-06-16 11:23:51 +01:00
releases Release note for #6176 in 2.10 2020-06-25 10:31:29 +01:00
topics Changelog/release note/contributor for #6040 2020-06-09 09:42:48 +01:00
autobuild.sh
conf.py fix sphinx warnings (#6001) 2020-05-03 14:02:43 +02:00
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 Add documentation for reporting security issues 2020-04-20 11:57:26 +10: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.