0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-28 00:17:06 +01:00
wagtail/docs
2021-10-06 20:57:32 +10: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 add ability to customise the pre-filled Image title 2021-10-06 19:53:30 +10:00
contributing update documentation & 2.15 release to drop IE11 support 2021-10-04 12:35:58 +01:00
editor_manual update documentation & 2.15 release to drop IE11 support 2021-10-04 12:35:58 +01:00
extending update documentation & 2.15 release to drop IE11 support 2021-10-04 12:35:58 +01:00
getting_started Add publish instructions for child pages in tutorial #7430 2021-08-13 17:30:51 +01:00
reference update hooks documentation to use mark_safe as no variables are used 2021-10-06 20:57:32 +10:00
releases add ability to customise the pre-filled Image title 2021-10-06 19:53:30 +10: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
README.md
requirements.txt Docs: Update sphinx-wagtail-theme to 5.0.4 (#7296) 2021-06-30 11:18:07 +02:00
robots.txt
spelling_wordlist.txt
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.