wagtail/docs
David Thompson 6a6555eb19 Fix multiple minor documentation issues
- Typo in readme (verb did not agree with the subject)
- Grammatical error in topics/pages
- #5364 - Update URL config code block in getting-started/integrating-into-django
2019-10-12 09:42:02 +10:00
..
_static Release note for StreamField design update (#5476) 2019-08-23 15:53:48 +01:00
advanced_topics Added 'image uploads in forms' to third party tutorials 2019-10-12 09:31:19 +10:00
contributing Clarify CHANGELOG instructions in "Committing code" docs (#5483) 2019-08-05 13:35:29 +01:00
editor_manual Add a note on 'Previewing and Submitting for Moderation' page about potential disabled moderation 2019-10-02 10:48:15 +01:00
getting_started Fix multiple minor documentation issues 2019-10-12 09:42:02 +10:00
reference Add example of template rendering to TableBlock docs 2019-10-12 09:29:10 +10:00
releases Fix multiple minor documentation issues 2019-10-12 09:42:02 +10:00
topics Fix multiple minor documentation issues 2019-10-12 09:42:02 +10: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
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 reduced size of logo 2015-07-07 14:41:41 +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 Add note about not asking support questions in multiple places 2018-07-11 11:09:45 +01:00

README.md

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.