mirror of
https://github.com/wagtail/wagtail.git
synced 2024-11-30 01:46:24 +01:00
1849f0d54a
We currently index all items in Elasticsearch using the root bulk api (at ``/_bulk``). This API is to allow multiple indices to be inserted into at once. However, Wagtail inserts into one index at a time so this is not needed. If we pass the index name as a parameter in the call to ``bulk()``, the index-specific bulk API will be used instead (at ``/<index name>/_bulk``. The advantage of this change is it makes it possible to implement access control by checking the URL an application is using. This is required in order for the Bulk API to work on certain hosts (such as Divio). |
||
|---|---|---|
| .. | ||
| _static | ||
| advanced_topics | ||
| contributing | ||
| editor_manual | ||
| getting_started | ||
| reference | ||
| releases | ||
| topics | ||
| autobuild.sh | ||
| conf.py | ||
| favicon.ico | ||
| index.rst | ||
| logo.png | ||
| Makefile | ||
| README.md | ||
| readthedocs.yml | ||
| requirements.txt | ||
| 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.