0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-30 01:46:24 +01:00
wagtail/docs
2021-05-28 16:39:24 +01:00
..
_static Prevent “Forgotten password” link from overlapping with field on mobile devices (#6748) 2021-05-14 22:26:44 +01:00
_templates
advanced_topics
contributing Update JavaScript guidelines to say two space indent 2021-05-17 15:26:10 +01:00
editor_manual
getting_started
reference Allow workflows to be disabled (#7218) 2021-05-26 19:23:28 +01:00
releases Add release note for #7212 in 2.13.1 2021-05-28 16:39:24 +01:00
topics Documentation for image rendition properties including full_url 2021-05-17 12:32:19 +01:00
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
Makefile
README.md
requirements.txt
robots.txt
spelling_wordlist.txt
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.