0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
2020-11-24 12:16:17 +00:00
..
_static
advanced_topics Add custom oEmbed finders for Facebook and Instagram (#6550) 2020-11-17 15:06:24 +00:00
contributing Drop travis entirely 2020-11-05 12:04:12 +00:00
editor_manual fix trailing whitespace 2020-10-21 12:12:34 +01:00
getting_started Formalise support for Python 3.9 2020-11-02 17:29:58 +00:00
reference Remove elasticsearch 2 support 2020-11-05 12:04:12 +00:00
releases Fill in release date for 2.11.2 2020-11-17 15:44:24 +00:00
topics remove double returns 2020-11-24 12:16:17 +00:00
autobuild.sh
conf.py Add custom robots.txt to docs 2020-11-12 16:35:05 +00:00
favicon.ico
index.rst
logo.png
Makefile Add config section for doc8 in setup.cfg and ignore _build dir 2020-10-21 12:39:32 +01:00
README.md
requirements.txt
robots.txt Add custom robots.txt to docs 2020-11-12 16:35:05 +00:00
spelling_wordlist.txt Add more names and jargon to spelling wordlist 2020-10-03 14:43:03 +01:00
support.rst

Wagtail docs

These are Sphinx docs, automatically built at https://docs.wagtail.io when the master 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.