0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
Matt Westcott d9a41e7f24 Escape help text in form builder forms by default
This can be disabled with the setting WAGTAILFORMS_HELP_TEXT_ALLOW_HTML
2020-07-20 10:36:28 +01:00
..
_static Tweak Wagtail logo hover animation in docs 2020-06-02 20:34:20 +10:00
advanced_topics Update third_party_tutorials.rst 2020-07-17 10:57:48 +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 Replace a few instances of re_path with path 2020-07-06 13:15:39 +01:00
reference Escape help text in form builder forms by default 2020-07-20 10:36:28 +01:00
releases Changelog update for #6151 & #6189 2020-07-16 16:20:44 +10:00
topics Changelog/release note/contributor for #6040 2020-06-09 09:42:48 +01:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py fix sphinx warnings (#6001) 2020-05-03 14:02:43 +02:00
favicon.ico add favicon to documentation 2018-03-08 12:24:13 +00:00
index.rst Fix broken link to bakerydemo (#4834) 2018-10-21 11:38:28 +02:00
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 readthedocs needs a requirements.txt, apparently 2017-10-09 19:45:07 +01:00
spelling_wordlist.txt Added more words to the spelling wordlist 2018-04-05 12:13:05 +01:00
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.