wagtail/docs
Matt Westcott 42c566b19b Remove note about database search not ordering by relevance
This text existed since Wagtail 1.x and is referring to the original database backend that just did substring matches (which is now the fallback backend), before we supported database-backed full-text search.
2024-07-24 22:31:53 +01:00
..
_static doc: fix pdf export (#12076) 2024-07-19 01:27:07 +01:00
_templates Extend the until date of the promotion banner for Wagtail Space 2024-06-13 15:16:29 +02:00
advanced_topics Upgrade Sphinx to 7.3; use newer syntax for no-index directive and --fail-on-warning switch 2024-07-23 10:13:03 +01:00
contributing Mention use of GitHub's security advisories 2024-05-08 12:34:39 +01:00
editor_manual
extending doc: fix pdf export (#12076) 2024-07-19 01:27:07 +01:00
getting_started Drop support for Python 3.8 2024-07-23 10:12:45 +01:00
public
reference Upgrade Sphinx to 7.3; use newer syntax for no-index directive and --fail-on-warning switch 2024-07-23 10:13:03 +01:00
releases Make StreamField migration a headline release note for 6.2 2024-07-23 11:56:34 +01:00
topics Remove note about database search not ordering by relevance 2024-07-24 22:31:53 +01:00
tutorial Update deployment instructions for Fly.io 2024-06-17 12:29:51 +01:00
Makefile Upgrade Sphinx to 7.3; use newer syntax for no-index directive and --fail-on-warning switch 2024-07-23 10:13:03 +01:00
README.md
conf.py doc: fix pdf export (#12076) 2024-07-19 01:27:07 +01:00
favicon.ico Update all other Wagtail logos to the latest version 2024-03-23 19:48:31 +10:00
index.rst Rename "advanced tutorial" to "full tutorial" (#11260) 2023-11-20 15:22:52 +00:00
logo.png Update all other Wagtail logos to the latest version 2024-03-23 19:48:31 +10:00
spelling_wordlist.txt
support.md Remove mention of Wagtail Google group 2023-12-15 11:29:45 +00:00

README.md

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.