0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
Thibaud Colas 29942d2a48
Add documentation formatting reference (#6729)
Co-authored-by: Andy Chosak <andy@chosak.org>
Co-authored-by: Tom Dyson <tom@torchbox.com>
2021-01-29 10:38:47 +00:00
..
_static Add documentation formatting reference (#6729) 2021-01-29 10:38:47 +00:00
advanced_topics Fix documentation typo 2021-01-27 16:01:06 +00:00
contributing Add documentation formatting reference (#6729) 2021-01-29 10:38:47 +00:00
editor_manual Add the option to set images as decorative 2021-01-29 10:24:14 +00:00
getting_started Formalise support for Python 3.9 2020-11-02 17:29:58 +00:00
reference add missing : to after_create_page example 2021-01-27 09:21:42 +00:00
releases Add release notes for #6730 2021-01-29 10:24:14 +00:00
topics Release notes for #6718 2021-01-26 10:55:26 +00:00
autobuild.sh
conf.py Configure Sphinx for Markdown support (#6711) 2021-01-26 22:09:52 +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 Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
requirements.txt
robots.txt revert to @allcaps's original approach to including robots.txt 2020-12-04 13:30:55 +00:00
spelling_wordlist.txt Add more names and jargon to spelling wordlist 2020-10-03 14:43:03 +01:00
support.rst Add documentation for reporting security issues 2020-04-20 11:57:26 +10:00

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.