wagtail/docs
DanAtShenTech 76072ce4a1 Fix typos
2018-04-06 16:17:14 +01:00
..
_static Fixes a Javascript month indexing. 2018-03-22 11:29:14 +01:00
advanced_topics Typo and clarification (#4319) 2018-03-08 12:40:25 +00:00
contributing Add IE11 opt-out of rich text pasting, and documentation notes 2018-01-17 22:16:35 +02:00
editor_manual Clarify explanation of white cross for adding multiple items (#4392) 2018-03-19 14:54:02 +01:00
getting_started Tutorial should refer to 'Pages', not 'Explorer' (#4293) 2018-02-16 10:31:44 +00:00
reference Fix typos 2018-04-06 16:17:14 +01:00
releases Fill in release date for 2.0.1 2018-04-04 14:59:05 +01:00
topics Used Python 3 super() syntax also in documentation. (#4246) 2018-02-07 10:12:24 +00:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py Adds a temporary docs banner to the Kickstarter project. 2018-03-22 10:13:54 +00:00
favicon.ico add favicon to documentation 2018-03-08 12:42:20 +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 Remove references to Gondor.io in documentation. 2017-01-30 12:36:26 +00: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.