0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
Tim Heap 1f2b8ccaf1 Filter pop-out explorer pages using 'construct_explorer_page_queryset'
The pages listed when browsing the /admin/pages/ explorer differed from
the pages listed in the new React/admin API powered pop-out explorer.
The latter did not pass the queryset through the
'construct_explorer_page_queryset' hook, so pages that should have been
hidden were visible. Visiting these pages in the explorer could then
lead to unexpected behaviours, as hidden sections of the site became
browsable.

A new `for_explorer=1` query parameter has been added to the admin API,
which will pass the page queryset through the
'construct_explorer_page_queryset' hooks.
2017-10-31 15:55:01 +00:00
..
_static/images Add 'The Zen of Wagtail' document 2017-09-27 12:20:34 +01:00
advanced_topics Move Usage info (Documents, Images) to sidebar 2017-10-26 14:34:58 +01:00
contributing Remove Python 2 references from docs 2017-10-13 12:24:42 +01:00
editor_manual Update documentation referring to the explorer menu 2017-05-17 13:14:50 +01:00
getting_started Remove more Django 1.8 references from docs 2017-10-25 16:15:02 +01:00
reference Merge pull request #3934 from gasman/cleanup/remove-python2 2017-10-26 14:41:43 +01:00
releases Filter pop-out explorer pages using 'construct_explorer_page_queryset' 2017-10-31 15:55:01 +00:00
topics Merge branch 'master' into cleanup/remove-python2 2017-10-25 16:21:27 +01:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py
index.rst
logo.png
Makefile add way of autocompile documentation 2017-02-20 20:24:17 +00:00
README.md
readthedocs.yml requirements_file not needed, but maybe pip_install is 2017-10-09 18:15:36 +01:00
requirements.txt readthedocs needs a requirements.txt, apparently 2017-10-09 19:45:07 +01:00
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.