0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
2020-10-01 08:06:43 +02:00
..
_static Update editor manual images where they show the old edit/workflow admin views before revamp 2020-08-07 17:10:26 +01:00
advanced_topics Remove note about MSSQL being known to work 2020-09-30 16:29:08 +01:00
contributing Make page-level actions accessible to keyboard users in page listing tables (#6280) 2020-08-01 21:52:28 +01:00
editor_manual Fix bulletpoint formatting, and update outdated information, particularly around available page statuses and the headings on the workflow edit view 2020-08-07 17:10:27 +01:00
getting_started Formalise Django 3.1 support 2020-08-06 11:26:26 +01:00
reference Add documentation for placeholder text in Field Panels 2020-10-01 08:06:43 +02:00
releases Force string url before passing to urlparse (#6341) 2020-09-30 08:10:50 +01:00
topics Update responsive embeds docs 2020-08-27 12:25:23 +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.