0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-30 11:10:43 +01:00
wagtail/docs
2021-03-04 10:32:44 +00:00
..
_static Move labels above the form field in the image format chooser 2021-02-26 09:19:20 +00:00
_templates Insert Plausible.io analytics code into docs 2021-02-18 18:14:10 +00:00
advanced_topics Change master to main (#6830) 2021-03-03 13:33:19 -05:00
contributing Change master to main (#6830) 2021-03-03 13:33:19 -05:00
editor_manual Change master to main (#6830) 2021-03-03 13:33:19 -05:00
getting_started Docs: Convert "getting started - tutorial" from RST to MD 2021-03-04 10:32:44 +00:00
reference Change master to main (#6830) 2021-03-03 13:33:19 -05:00
releases Change master to main (#6830) 2021-03-03 13:33:19 -05:00
topics Docs: Convert "topics - index" from RST to MD (#6852) 2021-03-03 11:41:29 +00:00
autobuild.sh
conf.py Change master to main (#6830) 2021-03-03 13:33:19 -05:00
favicon.ico
index.rst Move "writing documentation" page into Contributing (#6789) 2021-02-05 09:29:03 -05: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
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

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.