0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 03:31:04 +01:00
wagtail/docs
2019-10-09 12:16:59 +01:00
..
_static Release note for StreamField design update (#5476) 2019-08-23 15:53:48 +01:00
advanced_topics Add cache-busting parameter to admin static files 2019-10-09 12:16:56 +01: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 Add note about CurrentSiteMiddleware incompatibility 2019-09-02 16:18:41 +01:00
reference Documentation tweaks for WAGTAILDOCS_SERVE_METHOD 2019-09-21 18:53:48 +01:00
releases Added upgrade note about disabling version strings 2019-10-09 12:16:59 +01:00
topics Changed height's description to match width's. (#5593) 2019-10-02 09:32:16 +01:00
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
Makefile
README.md
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.