0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-30 01:46:24 +01:00
wagtail/docs
2019-03-29 11:25:01 +00:00
..
_static Add Wagtail Space Arnhem banner to documentation 2019-01-24 11:28:56 +00:00
advanced_topics Fix warnings on building documentation (#5145) 2019-03-15 02:03:56 +01:00
contributing Recommend npm install --no-save when setting up node toolchain (#5161) 2019-03-21 20:41:14 +00:00
editor_manual Update links to Draftail documentation 2019-02-14 23:24:30 +01:00
getting_started Add MEDIA_* settings to Django integration page (#5046) 2019-01-31 12:19:42 +00:00
reference Added an option to the page model to be able to define the amount of subpages underneath a specific parent page 2019-03-15 18:14:05 +01:00
releases Call specific on parent page and breadcrumbs in page chooser 2019-03-29 11:21:06 +00:00
topics Add documentation for the ajax_template attribute 2019-03-29 11:25:01 +00:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
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 add way of autocompile documentation 2017-02-20 20:24:17 +00:00
README.md Eliminate reference to requirements-dev.txt 2016-02-05 15:48:01 +00:00
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.