0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
2021-10-01 16:28:20 +01:00
..
_static Add screenshots 2021-08-03 16:07:18 +01:00
_templates Add Sphinx Wagtail Theme (#6930) 2021-04-20 11:24:17 +02:00
advanced_topics documentation - add third party tutorials from late 2020 to now 2021-08-19 18:53:20 +01:00
contributing Add section about CSV exports to security docs 2021-10-01 06:38:32 +10:00
editor_manual Updated the formatting of the bullets 2021-08-20 17:10:55 +01:00
extending Adding Notifications docs - update sample code 2021-09-26 20:46:29 +10:00
getting_started Add publish instructions for child pages in tutorial #7430 2021-08-13 17:30:51 +01:00
reference Include custom permissions hook documentation 2021-10-01 06:52:43 +10:00
releases Release note for #7540 2021-10-01 16:28:20 +01:00
topics Include custom permissions hook documentation 2021-10-01 06:52:43 +10:00
autobuild.sh
conf.py Add Sphinx Wagtail Theme (#6930) 2021-04-20 11:24:17 +02:00
favicon.ico
index.rst Add an 'Extending Wagtail' section to the docs 2021-08-03 16:07:18 +01:00
logo.png
Makefile Fix broken "make livehtml" command 2021-02-04 11:55:02 -08:00
README.md Change master to main (#6830) 2021-03-03 13:33:19 -05:00
requirements.txt Docs: Update sphinx-wagtail-theme to 5.0.4 (#7296) 2021-06-30 11:18:07 +02:00
robots.txt Reinstate spidering of other documentation versions besides stable 2021-02-02 15:15:43 +00:00
spelling_wordlist.txt Add more names and jargon to spelling wordlist 2020-10-03 14:43:03 +01:00
support.rst Link to Github discussion boards 2021-09-30 19:00:18 +10:00

Wagtail docs

These are Sphinx docs, automatically built at https://docs.wagtail.io when the main 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.