wagtail/docs
Jake Howard 0a9b23979b Update links to wagtail.io website to point to wagtail.org
This covers only links to the website, not other sites
2022-01-15 20:23:44 +10:00
..
_static fix all basic linting rules (mostly formatting) 2022-01-13 07:50:24 +00:00
_templates Update docs links to reference new domain 2022-01-15 20:04:24 +10:00
advanced_topics Update links to wagtail.io website to point to wagtail.org 2022-01-15 20:23:44 +10:00
contributing Update links to wagtail.io website to point to wagtail.org 2022-01-15 20:23:44 +10:00
editor_manual Update links to wagtail.io website to point to wagtail.org 2022-01-15 20:23:44 +10:00
extending Update links to wagtail.io website to point to wagtail.org 2022-01-15 20:23:44 +10:00
getting_started Drop support for Django <3.2 2022-01-14 14:23:56 +00:00
reference Update links to wagtail.io website to point to wagtail.org 2022-01-15 20:23:44 +10:00
releases Update links to wagtail.io website to point to wagtail.org 2022-01-15 20:23:44 +10:00
topics Formally deprecate old db search backends (#7651) 2021-10-28 10:53:32 +01:00
Makefile
README.md Update docs links to reference new domain 2022-01-15 20:04:24 +10:00
autobuild.sh
conf.py
favicon.ico
index.rst Update links to wagtail.io website to point to wagtail.org 2022-01-15 20:23:44 +10:00
logo.png
requirements.txt
robots.txt Update docs links to reference new domain 2022-01-15 20:04:24 +10:00
spelling_wordlist.txt
support.rst Update links to wagtail.io website to point to wagtail.org 2022-01-15 20:23:44 +10:00

README.md

Wagtail docs

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