wagtail/docs
Robert Rollins cbabc3d9c7 Page.dummy_request() now takes an optional request object argument.
When building a dummy request, you can now pass in the original request object
to add additional information to the dummy. Currently, that includes the
following headers:
REMOTE_ADDR
HTTP_X_FORWARDED_FOR
HTTP_COOKIE
HTTP_USER_AGENT

More may be added later.

This changes ensures that middleware which work on the client IP aren't flumuxed
by its absense, and also makes it possible for previews to be rendered as the
logged in user (they had previously been rendered using an AnnonymousUser).

Because the user's logged in state is now detectable in a Page previews, the
Wagtail userbar now hides itself explicitly during previews, rather than relying
on the fact that previews used to be built with AnonymousUser.
2016-07-06 20:28:05 +01:00
..
_static/images promote rich text link handling to a major feature 2016-05-19 17:01:17 +01:00
advanced_topics Documented the settings variable for WAGTAIL_USAGE_COUNT_ENABLED (#2706) 2016-06-13 20:47:27 +01:00
contributing Document isort and 'make lint' in Python coding guidelines 2016-06-23 16:31:44 +01:00
editor_manual Correcting typo int The Dashboard doc 2016-02-16 15:51:57 -05:00
getting_started add note about Wagtail <=1.4 syntax for search_fields 2016-05-02 18:42:21 +01:00
reference Makes notes for settings module more visible (#2826) 2016-07-06 19:01:09 +03:00
releases Page.dummy_request() now takes an optional request object argument. 2016-07-06 20:28:05 +01:00
topics Adds the include_block template tag (#2786) 2016-07-06 17:44:02 +03:00
Makefile
README.md Eliminate reference to requirements-dev.txt 2016-02-05 15:48:01 +00:00
autobuild.sh
conf.py
index.rst Moved advanced image topics into advanced topics 2016-01-27 11:27:16 +00:00
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.