0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 09:33:54 +01:00
wagtail/docs
Matt Westcott 080c3b9b30 Remove search logging from project template
The search view on the project template is still attempting to log queries against the now-removed wagtailsearch.Query model - as of 6.0a0 this is causing an ImportError when running initial migrations on a newly-created project.

Since the wagtail.contrib.search_promotions module is optional (and off by default on new projects), I've opted to comment out the query logging code with instructions for developers who wish to re-enable it.
2023-11-07 09:23:09 +11:00
..
_static Update tutorial screenshots for v5.2 2023-11-01 09:22:11 +00:00
_templates Bump djhtml to 3.0.6 (#11158) 2023-10-31 10:11:02 +00:00
advanced_topics Remove use_json_field parameter from StreamField 2023-11-01 16:52:20 +00:00
contributing Drop support for Elasticsearch 5 and 6 2023-11-01 14:57:15 +00:00
editor_manual
extending Remove ModelAdmin 2023-11-01 16:52:20 +00:00
getting_started Documentation - fix broken refs & pygments formats 2023-10-13 11:45:41 +01:00
public
reference Remove use_json_field parameter from StreamField 2023-11-01 16:52:20 +00:00
releases Remove search logging from project template 2023-11-07 09:23:09 +11:00
topics Fix code example for {% picture ... as ... %} tag - fixes #11186 2023-11-06 16:35:28 +00:00
autobuild.sh
conf.py Run pyupgrade with --py38-plus 2023-07-14 13:06:41 +01:00
favicon.ico
index.rst
logo.png
Makefile
README.md Resolve multiple typos (spelling and grammar) 2023-05-30 21:07:37 +10:00
spelling_wordlist.txt Resolve multiple typos (spelling and grammar) 2023-05-30 21:07:37 +10:00
support.md Resolve multiple typos (spelling and grammar) 2023-05-30 21:07:37 +10:00

Wagtail docs

These are Sphinx docs, automatically built at https://docs.wagtail.org when the main 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 MyST playground at Curvenote or the MyST-Markdown VS Code Extension are helpful tools for working with the MyST syntax.