0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-28 17:13:31 +01:00
wagtail/docs
2018-03-22 10:12:48 +00:00
..
_static Adds a temporary docs banner to the Kickstarter project. 2018-03-22 10:12:48 +00:00
advanced_topics Typo and clarification (#4319) 2018-02-27 22:08:57 +02:00
contributing
editor_manual Wording fix (#4280) 2018-02-13 23:01:03 +00:00
getting_started Tutorial should refer to 'Pages', not 'Explorer' (#4293) 2018-02-16 10:31:12 +00:00
reference Adds a new HelpPanel (#4374) 2018-03-15 16:46:34 +01:00
releases Changelog for #4397. 2018-03-22 03:03:19 +01:00
topics Fix typo 2018-03-16 19:54:59 +01:00
autobuild.sh
conf.py Adds a temporary docs banner to the Kickstarter project. 2018-03-22 10:12:48 +00:00
favicon.ico add favicon to documentation 2018-03-08 12:24:13 +00:00
index.rst
logo.png
Makefile
README.md
readthedocs.yml
requirements.txt
spelling_wordlist.txt
support.rst

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.