0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
Coen van der Kamp 68b2dc01c2 Render user bar on non page views
* resolves #5565
2020-05-10 16:10:45 +10:00
..
_static fix sphinx warnings (#6001) 2020-05-03 14:02:43 +02:00
advanced_topics Update ImageRendition field to return Image alt text 2020-05-08 11:22:49 +10:00
contributing Upgrade to Gulp v4 & Node 10 2020-05-01 12:01:03 +10:00
editor_manual Author specific locking docs changes (#5771) 2020-01-28 09:07:01 +00:00
getting_started Remove support for Django 2.1 (#5840) 2020-02-18 13:55:53 +00:00
reference Add purge_revisions management command 2020-05-08 11:35:30 +10:00
releases Render user bar on non page views 2020-05-10 16:10:45 +10:00
topics Render user bar on non page views 2020-05-10 16:10:45 +10: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 reduced size of logo 2015-07-07 14:41:41 +01:00
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.