0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
2019-06-07 18:13:04 +01:00
..
_static Make the page reordering UI easier to find (#5187) 2019-03-29 14:38:05 +00:00
advanced_topics Implemented branding title prefix customization (#5344) 2019-06-07 17:06:00 +01:00
contributing Remove bad practice example from CSS guidelines 2019-06-06 17:04:23 +01:00
editor_manual Fix small typos/grammar in documentation 2019-04-30 07:35:45 +10:00
getting_started Remove support for Python 3.4 2019-04-10 17:39:53 +01:00
reference Revise wording of static resources usage in modeladmin documentation 2019-05-23 07:25:12 +10:00
releases Add release notes for #5359 (#5363) 2019-06-07 18:13:04 +01:00
topics Create reference in docs to PostgreSQL backend 2019-05-03 13:36:02 +01: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
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.