0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
2021-01-27 09:21:42 +00:00
..
_static Update editor manual images where they show the old edit/workflow admin views before revamp 2020-08-07 17:10:26 +01:00
advanced_topics Implement CSS variables for admin color theming (#6409) 2021-01-17 02:17:41 +00:00
contributing Change UniqueConstraint for wider database support (#6607) 2021-01-18 11:52:52 +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 add missing : to after_create_page example 2021-01-27 09:21:42 +00:00
releases Configure Sphinx for Markdown support (#6711) 2021-01-26 22:09:52 +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 add favicon to documentation 2018-03-08 12:24:13 +00:00
index.rst Fix broken link to bakerydemo (#4834) 2018-10-21 11:38:28 +02:00
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 readthedocs needs a requirements.txt, apparently 2017-10-09 19:45:07 +01:00
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.