wagtail/docs
Jaap Roes 8d0eff1717
Fix typo in hooks reference example (#6926)
2021-03-16 17:14:52 +00:00
..
_static Fix the DocSearch search input appearing smaller after initialization (#6883) 2021-03-08 13:35:21 +00:00
_templates Fix DocSearch widget initialisation JS error (#6884) 2021-03-08 14:18:01 +00:00
advanced_topics Replace example YouTube url with a working one (#6923) 2021-03-16 10:41:09 +00:00
contributing
editor_manual
getting_started
reference Fix typo in hooks reference example (#6926) 2021-03-16 17:14:52 +00:00
releases Add support for SVG icons to SearchArea subclasses and register_admin_search_area (#6493) 2021-03-09 11:33:06 +00:00
topics
Makefile
README.md
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
requirements.txt
robots.txt
spelling_wordlist.txt
support.rst

README.md

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.