wagtail/docs
Matt Westcott 3c44037b2f Fix warnings on building documentation (#5145)
* Fix "Duplicate explicit target name" warnings on extending_draftail.rst

ref: https://github.com/sphinx-doc/sphinx/issues/3921

* Fix 'Unknown target name' warning on third_party_tutorials.rst

* Add docstrings to Page.get_ancestors, get_descendants and get_siblings

Documents the `inclusive` flag and avoids the "Field list ends without a blank line; unexpected unindent" warning when building docs
2019-03-15 02:03:56 +01:00
..
_static Add Wagtail Space Arnhem banner to documentation 2019-01-24 11:28:56 +00:00
advanced_topics Fix warnings on building documentation (#5145) 2019-03-15 02:03:56 +01:00
contributing
editor_manual Update links to Draftail documentation 2019-02-14 23:24:30 +01:00
getting_started Add MEDIA_* settings to Django integration page (#5046) 2019-01-31 12:19:42 +00:00
reference Move reversing_urls.rst into a subdirectory with it's own index, and include that index in the modeladmin docs' main toctree 2019-03-14 09:48:02 +01:00
releases Add more built-in rich text formats (#5141) 2019-03-15 01:39:18 +01:00
topics Added fallback to pageurl (#4603) 2019-03-13 12:17:13 +01:00
Makefile
README.md
autobuild.sh
conf.py Add Wagtail Space Arnhem banner to documentation 2019-01-24 11:28:56 +00:00
favicon.ico
index.rst
logo.png
requirements.txt
spelling_wordlist.txt
support.rst

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.