wagtail/docs
Nick Smith 781c2d14d3 Add How-To instructions for landing-page redirects
This uses both the forms and routable_page contrib modules to redirect
without using a separate landing page.
2021-10-04 14:12:28 +10:00
..
_static
_templates
advanced_topics Add How-To instructions for landing-page redirects 2021-10-04 14:12:28 +10:00
contributing Fix link to node.js download 2021-10-02 12:52:47 +10:00
editor_manual
extending Document the new 'log' method 2021-10-01 16:30:05 +01:00
getting_started
reference Include custom permissions hook documentation 2021-10-01 06:52:43 +10:00
releases Add How-To instructions for landing-page redirects 2021-10-04 14:12:28 +10:00
topics Include custom permissions hook documentation 2021-10-01 06:52:43 +10:00
Makefile
README.md
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
requirements.txt
robots.txt
spelling_wordlist.txt
support.rst Link to Github discussion boards 2021-09-30 19:00:18 +10:00

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.