0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
2019-10-23 17:52:20 +02:00
..
_static Release note for StreamField design update (#5476) 2019-08-23 15:53:48 +01:00
advanced_topics Release note for #5249 / #5629 2019-10-16 16:21:26 +01:00
contributing Clarify CHANGELOG instructions in "Committing code" docs (#5483) 2019-08-05 13:35:29 +01:00
editor_manual Add a note on 'Previewing and Submitting for Moderation' page about potential disabled moderation 2019-10-02 10:48:15 +01:00
getting_started Formalise Python 3.8 support 2019-10-22 16:23:44 +01:00
reference Add model to PersonAdmin in documentation 2019-10-16 10:54:05 +01:00
releases Add 2.8 section to changelog and release notes 2019-10-23 17:52:20 +02:00
topics syntax => keyword 2019-10-16 16:24:24 +01:00
autobuild.sh
conf.py Add Wagtail Space Arnhem banner to documentation 2019-01-24 11:28:56 +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
README.md
requirements.txt readthedocs needs a requirements.txt, apparently 2017-10-09 19:45:07 +01:00
spelling_wordlist.txt Added more words to the spelling wordlist 2018-04-05 12:13:05 +01:00
support.rst Add note about not asking support questions in multiple places 2018-07-11 11:09:45 +01:00

Wagtail docs

These are Sphinx docs, automatically built at http://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.