0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 09:33:54 +01:00
wagtail/docs
2018-06-14 14:54:49 +01:00
..
_static rename docs image 2018-06-14 12:40:28 +01:00
advanced_topics Add full documentation for WAGTAILADMIN_RICH_TEXT_EDITORS. Fixes #4555 2018-06-10 12:45:48 +10:00
contributing Add IE11 opt-out of rich text pasting, and documentation notes 2018-01-17 22:16:35 +02:00
editor_manual Add note about deleting in docs 2018-06-14 14:54:49 +01:00
getting_started updated Django Docs Links to point to *docs.djangoproject.com/en/stable/* 2018-05-18 14:43:42 +01:00
reference Reference the get_url method in Page model reference docs 2018-05-18 15:26:06 +01:00
releases Release note for #3355 2018-06-11 19:02:18 +01:00
topics updated Django Docs Links to point to *docs.djangoproject.com/en/stable/* 2018-05-18 14:43:42 +01:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py Removes the temporary Kickstarter banner. 2018-04-16 17:16:05 +02:00
favicon.ico add favicon to documentation 2018-03-08 12:24:13 +00:00
index.rst Moved advanced image topics into advanced topics 2016-01-27 11:27:16 +00:00
logo.png reduced size of logo 2015-07-07 14:41:41 +01:00
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
readthedocs.yml requirements_file not needed, but maybe pip_install is 2017-10-09 18:15:36 +01: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 Mention Slack on support documentation 2017-11-15 21:06:45 +00: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.