wagtail/docs
Vlad Podgurschi f54e7e1e41 Add instructions on copying and aliasing pages to the editor's guide #7010 2021-07-06 20:44:10 +01:00
..
_static Add instructions on copying and aliasing pages to the editor's guide #7010 2021-07-06 20:44:10 +01:00
_templates Add Sphinx Wagtail Theme (#6930) 2021-04-20 11:24:17 +02:00
advanced_topics Refactor getChooserConfig / filterEntityData into subclasses of ModalWorkflowSource 2021-06-28 12:25:29 +01:00
contributing Give quoted and unquoted versions of pip install commands 2021-07-05 17:53:12 +01:00
editor_manual Add instructions on copying and aliasing pages to the editor's guide #7010 2021-07-06 20:44:10 +01:00
getting_started Drop support for Django 2.2 2021-04-30 10:33:41 +01:00
reference Remove docs for WAGTAILSEARCH_RESULTS_TEMPLATE, WAGTAILSEARCH_RESULTS_TEMPLATE_AJAX 2021-06-28 11:23:24 +01:00
releases Add instructions on copying and aliasing pages to the editor's guide #7010 2021-07-06 20:44:10 +01:00
topics Add keyboard and screen reader support to Wagtail user bar (#6994). Fix #6108 2021-06-26 20:53:44 +01:00
Makefile
README.md
autobuild.sh
conf.py Add Sphinx Wagtail Theme (#6930) 2021-04-20 11:24:17 +02:00
favicon.ico
index.rst Replace Divio with Gitpod 2021-04-20 17:19:33 +01:00
logo.png
requirements.txt Docs: Update sphinx-wagtail-theme to 5.0.4 (#7296) 2021-06-30 11:18:07 +02:00
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.