wagtail/docs
Karl Hobley 17f7f70170 Added "find" API view and ability to find pages by HTML path
This implements a new "find" view for all endpoints which can be used
for finding an individual object based on the URL parameters passed to
it.

If an object is found, the view will return a ``302`` redirect to detail
page of that object. If not, the view will return a ``404`` response.

For the pages endpoint, I've added a ``html_path`` parameter to this
view, this allows finding a page by its path on the site.

For example a GET request to ``/api/v2/pages/find/?html_path=/`` will
always generate a 302 response to the detail view of the homepage. This
uses Wagtail's internal routing mechanism so routable pages are
supported as well.

Fixes #4154
2018-04-13 12:08:19 +01:00
..
_static Fixed #4423 -- Fixed background color in docs css. 2018-04-12 10:55:24 +02:00
advanced_topics Added "find" API view and ability to find pages by HTML path 2018-04-13 12:08:19 +01:00
contributing Add IE11 opt-out of rich text pasting, and documentation notes 2018-01-17 22:16:35 +02:00
editor_manual Fix spelling mistakes in documentation 2018-04-05 12:13:05 +01:00
getting_started Fix capitalisation of QuerySet 2018-04-05 12:13:05 +01:00
reference Typo 2018-04-11 13:22:45 +01:00
releases Added "find" API view and ability to find pages by HTML path 2018-04-13 12:08:19 +01:00
topics Wording clarification 2018-04-06 16:23:04 +01:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py Adds a temporary docs banner to the Kickstarter project. 2018-03-22 10:12:48 +00:00
favicon.ico add favicon to documentation 2018-03-08 12:24:13 +00:00
index.rst Moved advanced image topics into advanced topics 2016-01-27 11:27:16 +00:00
logo.png reduced size of logo 2015-07-07 14:41:41 +01:00
Makefile add way of autocompile documentation 2017-02-20 20:24:17 +00:00
README.md Eliminate reference to requirements-dev.txt 2016-02-05 15:48:01 +00:00
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 Added more words to the spelling wordlist 2018-04-05 12:13:05 +01:00
support.rst Mention Slack on support documentation 2017-11-15 21:06:45 +00:00

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.