wagtail/docs
Tim Heap 44564ea76a Link to homepage from dashboard page link if single site
If the Wagtail install has only one site, link to the homepage of that
site from the dashboard page summary instead of the root page of the
hierarchy.

Hopefully this will prevent some of the confusion causing people to
create pages under the root page, where they are inaccessible. See #1612
for more information around this issue.

Wagtail installs with multiple (or zero) sites retain the old behaviour
of linking to the root page.
2015-12-16 14:53:56 +00:00
..
_static/images
advanced_topics
contributing
editor_manual
getting_started
reference
releases Link to homepage from dashboard page link if single site 2015-12-16 14:53:56 +00:00
topics
Makefile
README.md
autobuild.sh
conf.py
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 -r requirements-dev.txt

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.