0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-30 11:10:43 +01:00
wagtail/docs
2018-10-28 17:28:53 +03:00
..
_static Address more feedback on new welcome page 2018-10-27 19:10:31 +03:00
advanced_topics Add template tag for dynamic image url 2018-10-28 16:21:46 +03:00
contributing Add PyPI trove classifiers for Wagtail 2018-10-28 16:43:42 +03:00
editor_manual Update editor guide for embeds and documents in rich text, fix #4558 (#4632) 2018-07-09 10:07:03 +03:00
getting_started Clarify virtualenv steps for easier getting started 2018-10-27 11:49:12 +03:00
reference Document the Dockerfile in the project template (#4853) 2018-10-27 15:18:25 +02:00
releases Adds release notes for #4850 2018-10-28 17:28:53 +03:00
topics Specify Elasticsearch <6.3.1 2018-08-10 14:27:07 +01:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py Use current year for the copyright notice 2018-10-25 18:14:36 +01: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.