wagtail/docs
Matt Westcott 92cc026694 Rename docs page to 'Using forms in admin views' 2022-03-02 15:55:25 +00:00
..
_static Remove all style customisations for documentation, except banner. Fix #7987 (#7990) 2022-02-18 13:41:18 +00:00
_templates Indent templates with djhtml 2022-02-12 01:15:51 +00:00
advanced_topics Remove references to StreamFieldPanel and ChooserPanels from docs 2022-03-02 15:55:25 +00:00
contributing Tailwind package setup (#8003) 2022-02-27 16:08:38 +00:00
editor_manual Remove IE11 warning message and related files 2022-02-22 17:22:39 +10:00
extending Rename docs page to 'Using forms in admin views' 2022-03-02 15:55:25 +00:00
getting_started Remove references to StreamFieldPanel and ChooserPanels from docs 2022-03-02 15:55:25 +00:00
reference Remove references to StreamFieldPanel and ChooserPanels from docs 2022-03-02 15:55:25 +00:00
releases Add upgrade consideration note for third-party packages implementing their own panels 2022-03-02 15:55:25 +00:00
topics Remove references to StreamFieldPanel and ChooserPanels from docs 2022-03-02 15:55:25 +00:00
Makefile
README.md
autobuild.sh
conf.py Reformat with black 2022-02-15 13:06:17 +00:00
favicon.ico
index.rst
logo.png
requirements.txt
robots.txt
spelling_wordlist.txt
support.rst Update email addresses for new .org domain (#7845) 2022-01-28 12:16:24 +00: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.