wagtail/docs
Coen van der Kamp 68f2cc5f7e
Add Wagtail Space NL 2022 banner to docs (#8264)
2022-04-01 10:58:02 +01:00
..
_static Add Wagtail Space NL 2022 banner to docs (#8264) 2022-04-01 10:58:02 +01:00
_templates
advanced_topics
contributing Remove description of some-day milestone (#8255) 2022-03-30 15:52:51 -04:00
editor_manual
extending
getting_started
reference Renumber Wagtail 2.17 to 3.0 2022-03-31 06:38:27 +10:00
releases forms - remove unidecode and legacy clean name approach 2022-03-31 14:53:44 +01:00
topics Renumber Wagtail 2.17 to 3.0 2022-03-31 06:38:27 +10:00
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.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.