wagtail/docs
Matt Westcott 9f084fff6d Add StreamField to title of BoundBlocks page 2021-03-23 18:57:53 +00:00
..
_static
_templates
advanced_topics Add StreamField to title of BoundBlocks page 2021-03-23 18:57:53 +00:00
contributing
editor_manual Duplicate block - editor docs 2021-03-17 23:32:57 +00:00
getting_started
reference Add reference page for the client-side widget API 2021-03-23 18:57:53 +00:00
releases Release notes for telepath StreamField implementation 2021-03-23 18:57:53 +00:00
topics Create a 'streamfield' subsection within the reference docs 2021-03-23 18:57:53 +00: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.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.